Skip to content
Back to top
View this page

# Changelog

## 0.6.0

2025-10-15

### New Features

- Use `github-token` also for target repository checkout (#123 by @Bibo-Joshi)

### Documentation

- Skip Inherited Members for `chango.config.ChanGoConfig` (#129 by @Bibo-Joshi)

### Internal Changes

- Bump actions/checkout from 4.2.2 to 5.0.0 (#112 by @dependabot[bot])

- Bump codecov/codecov-action from 5.4.3 to 5.5.0 (#113 by @dependabot[bot])

- Bump astral-sh/setup-uv from 6.4.3 to 6.6.0 (#114 by @dependabot[bot])

- Bump github/codeql-action from 3.29.7 to 3.29.11 (#115 by @dependabot[bot])

- Bump actions/download-artifact from 4.3.0 to 5.0.0 (#116 by @dependabot[bot])

- Bump pypa/gh-action-pypi-publish from 1.12.4 to 1.13.0 (#117 by @dependabot[bot])

- Bump actions/setup-python from 5.6.0 to 6.0.0 (#118 by @dependabot[bot])

- Bump github/codeql-action from 3.29.11 to 3.30.5 (#119 by @dependabot[bot])

- Bump astral-sh/setup-uv from 6.6.0 to 6.8.0 (#120 by @dependabot[bot])

- Bump actions/github-script from 7.0.1 to 8.0.0 (#121 by @dependabot[bot])

- Bump pre-commit Dependency Versions (#122 by @pre-commit-ci[bot])

- Update Dependabot Schedule to Quarterly (#128 by @Bibo-Joshi)

- Bump Version to 0.6.0 (#130 by @Bibo-Joshi)

## 0.5.0

2025-08-02

### New Features

- Use `git add` in `Chango.write_change_note` if available (#108 by @Bibo-Joshi closes #106)

- Allow Several `author_uids` in `sections.PullRequest` (#110 by @Bibo-Joshi closes #107)

### Internal Changes

- Bump actions/setup-python from 5.4.0 to 5.5.0 (#83 by @dependabot[bot])

- Bump codecov/test-results-action from 1.0.2 to 1.1.0 (#84 by @dependabot[bot])

- Bump github/codeql-action from 3.28.10 to 3.28.13 (#85 by @dependabot[bot])

- Bump actions/download-artifact from 4.1.8 to 4.2.1 (#86 by @dependabot[bot])

- Bump actions/upload-artifact from 4.6.0 to 4.6.2 (#87 by @dependabot[bot])

- Bump pre-commit Dependency Versions (#88 by @pre-commit-ci[bot])

- Bump actions/setup-python from 5.5.0 to 5.6.0 (#89 by @dependabot[bot])

- Bump actions/download-artifact from 4.2.1 to 4.3.0 (#90 by @dependabot[bot])

- Bump stefanzweifel/git-auto-commit-action from 5.1.0 to 5.2.0 (#91 by @dependabot[bot])

- Bump github/codeql-action from 3.28.13 to 3.28.16 (#92 by @dependabot[bot])

- Bump astral-sh/setup-uv from 5.3.0 to 6.0.1 (#93 by @dependabot[bot])

- Bump codecov/codecov-action from 5.4.0 to 5.4.3 (#94 by @dependabot[bot])

- Bump github/codeql-action from 3.28.16 to 3.28.18 (#96 by @dependabot)

- Bump codecov/test-results-action from 1.1.0 to 1.1.1 (#97 by @dependabot[bot])

- Adapt Test Suite to `click` Update (#98 by @Bibo-Joshi)

- Implement PEP 735 Dependency Groups (#99 by @Bibo-Joshi)

- Bump stefanzweifel/git-auto-commit-action from 5.2.0 to 6.0.1 (#100 by @dependabot)

- Bump pre-commit Dependency Versions (#101 by @pre-commit-ci)

- Update furo requirement from ~=2024.8 to >=2024.8,<2026.0 (#102 by @dependabot)

- Bump astral-sh/setup-uv from 6.0.1 to 6.4.3 (#103 by @dependabot)

- Bump github/codeql-action from 3.29.2 to 3.29.5 (#104 by @dependabot)

- Bump sigstore/gh-action-sigstore-python from 3.0.0 to 3.0.1 (#105 by @dependabot)

## 0.4.0

2025-03-09

### New Features

- Add Workaround for PRs from Forks (#79 by @Bibo-Joshi)

- Check for Changes in `DirectoryChanGo.build_github_event_change_note` (#80 by @Bibo-Joshi)

### Documentation

- Documentation Improvements (#81 by @Bibo-Joshi)

### Internal Changes

- Bump stefanzweifel/git-auto-commit-action from 5.0.1 to 5.1.0 (#74 by @dependabot[bot])

- Bump codecov/codecov-action from 5.3.1 to 5.4.0 (#75 by @dependabot[bot])

- Bump pypa/gh-action-pypi-publish from 1.12.3 to 1.12.4 (#76 by @dependabot[bot])

- Bump github/codeql-action from 3.28.8 to 3.28.10 (#77 by @dependabot[bot])

- Bump astral-sh/setup-uv from 5.1.0 to 5.3.0 (#78 by @dependabot[bot])

- Bump Version to 0.4.0 (#82 by @Bibo-Joshi)

## 0.3.2

2025-02-07

### Bug Fixes

- Fix Link Returned by `GitHubSectionChangeNot.get_thread_url` (#72 by @Bibo-Joshi closes #71)

### Internal Changes

- Remove Debugging Content (#70 by @Bibo-Joshi)

- Bump Version to 0.3.2 (#73 by @Bibo-Joshi)

## 0.3.1

2025-02-06

### Bug Fixes

- Fix Faulty Build Configuration (#68 by @Bibo-Joshi)

### Internal Changes

- Bump Version to 0.3.1 (#69 by @Bibo-Joshi)

## 0.3.0

2025-02-04

### Breaking Changes

- Adapt expected exceptions in `ChanGo` and `VersionScanner` to use `ChanGoError` (#64 by @Bibo-Joshi)

### New Features

- Add Classes `BackwardCompatibleVersionScanner` and `BackwardCompatibleChanGo` allowing to easily transition between change not formats (#64 by @Bibo-Joshi)

### Internal Changes

- Switch to using `GitHubSectionChangeNote` (#64 by @Bibo-Joshi)

- Bump Version to 0.3.0 (#66 by @Bibo-Joshi)

## 0.2.0

2025-02-03

- FIx Sorting Direction in `HeaderVersionHistory.render` (#46)

- Add `chango.concrete.sections` (#47)

- Implement `GitHubSectionChangeNote.build_from_github_event` And Several Adaptions on GitHub Automation (#50)

- Bump astral-sh/setup-uv from 4.2.0 to 5.1.0 (#52)

- Bump actions/upload-artifact from 4.4.3 to 4.5.0 (#53)

- Bump github/codeql-action from 3.27.9 to 3.28.0 (#54)

- Bump codecov/codecov-action from 5.1.1 to 5.1.2 (#55)

- Bump pre-commit Dependency Versions (#56)

- Don’t Enforce One Required Section in `SectionChangeNote` (#57)

- Fix Nesting Bug in Parsing `rich` to `sphinx` Syntax (#58)

- Bump github/codeql-action from 3.28.0 to 3.28.8 (#59)

- Bump codecov/test-results-action from 1.0.1 to 1.0.2 (#60)

- Bump actions/setup-python from 5.3.0 to 5.4.0 (#61)

- Bump actions/upload-artifact from 4.5.0 to 4.6.0 (#62)

- Bump codecov/codecov-action from 5.1.2 to 5.3.1 (#63)

- Bump Version to 0.2.0 (#65)

## 0.1.0

2024-12-15

- Use `git mv` in `ChanGo.release` if Available (#43)

- Set up Action Metadata for Publishing on Marketplace (#44)

- Bump Version to 0.1.0 (#45)

## 0.0.1

2024-12-13

- Initial Commit

- Add Initial Functionality (#1)

- Set Up Initial ReadTheDocs Build (#2)

- Add Types to Docstrings: `chango` and `chango.abc` (#4)

- Add Types To Docstrings: `chango.concrete` (#5)

- Add CLI to Sphinx Documentation (#6)

- Set Up Unified Formatting for CLI Help Texts and HTML Documentation (#7)

- Add Unit Tests for Direct Members of `chango` Package (#8)

- Make Use of `pytest-xdist` and `pytest-randomly` (#9)

- Cache Dependencies in CI (#10)

- Add Python 3.13 to Test Matrix (#11)

- Improve Coverage of Existing Tests (#12)

- Add Unit Tests for `chango.abc.ChangeNote` (#13)

- Improve Coverage Configuration (#14)

- Make `ChangeNote.to_bytes` Concrete (#15)

- Add Unit Tests for `chango.abc.VersionNote` (#16)

- Add Unit Tests for `chango.abc.VersionHistory` (#17)

- Add Unit Tests for `chango.concrete.Comment(Change|Version)Note` (#18)

- Remove Redundant Logic From and Add Unit Tests for `HeaderVersionHistory` (#19)

- Add Unit Tests for `DirectoryVersionScanner` (#20)

- Add Unit Tests for `VersionScanner` (#21)

- Add Unit Tests for `DirectoryChanGo` (#22)

- Remove Redundant `CommentChangeNote.to_bytes` (#23)

- Add Unit Tests for `ChanGo` (#24)

- Initial Setup for Testing the CLI (#25)

- Initial Readme Content and Changelog Setup (#26)

- Create Change Notes from GitHub Events and Add GitHub Action (#27)

- Add Sphinx Extension (#28)

- Add Public `chango.config` Module (#29)

- Make Parameter `base_directory` of `DirectoryVersionScanner` Relative to Calling Module (#33)

- Add `VersionScanner.invalidate_caches` (#34)

- Increase Code Coverage (#35)

- Add Unit Tests for CLI (#36)

- Add Dependabot and Security Scanning for GitHub Actions (#37)

- Update `sphinx` requirement from ~=8.0 to ~=8.1 (#38)

- Add Workflows for Automated Releases (#39)

- Bump Version to 0.0.1 (#41)