Skip to content

Commit

Permalink
Fix path to changelog markdown file
Browse files Browse the repository at this point in the history
  • Loading branch information
tpvasconcelos committed Apr 19, 2024
1 parent 6e5b8bf commit b610a50
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .bumpversion.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ replace = __version__ = "{new_version}"
search = v_public == "{current_version}"
replace = v_public == "{new_version}"

[bumpversion:file:CHANGES.md]
[bumpversion:file:docs/reference/changelog.md]
search = Unreleased changes
------------------
replace = Unreleased changes
Expand Down
4 changes: 2 additions & 2 deletions bin/extract_latest_release_notes.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"""Extract the latest release notes
Execution steps:
- Extracts the latest release notes from the CHANGES.md file.
- Extracts the latest release notes from docs/reference/changelog.md
- The output is written to the `LATEST_RELEASE_NOTES.md` file.
- The body of this file is then used as the body of the GitHub release.
"""
Expand All @@ -18,7 +18,7 @@
from markdown_it.token import Token

PATH_TO_TOP_LEVEL = Path(__file__).parent.parent
PATH_TO_CHANGES = PATH_TO_TOP_LEVEL.joinpath("CHANGES.md")
PATH_TO_CHANGES = PATH_TO_TOP_LEVEL.joinpath("docs/reference/changelog.md")
PATH_TO_LATEST_RELEASE_NOTES = PATH_TO_TOP_LEVEL.joinpath("LATEST_RELEASE_NOTES.md")


Expand Down
4 changes: 2 additions & 2 deletions docs/development/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ make init-jupyter

4. Include tests that cover any code changes you make, and make sure the test fails without your patch.

5. Add an entry to CHANGES.md summarising the changes in this pull request. The entry should follow the same style and format as other entries, i.e.
5. Add an entry to {repo-file}`docs/reference/changelog.md` summarising the changes in this pull request. The entry should follow the same style and format as other entries, i.e.

> `- Your summary here. (#XXX)`
Expand Down Expand Up @@ -184,7 +184,7 @@ For more context on some of the tools referenced below, refer to the sections on
You need push access to the project's repository to make releases. The following release steps are here for reference only.
1. Review the `## Unreleased changes` section in CHANGES.md by checking for consistency in format and, if necessary, refactoring related entries into relevant subsections (e.g. _Features_, _Docs_, _Bugfixes_, _Security_, etc.). Take a look at previous release notes for guidance and try to keep it consistent.
1. Review the `## Unreleased changes` section in {repo-file}`docs/reference/changelog.md` by checking for consistency in format and, if necessary, refactoring related entries into relevant subsections (e.g. _Features_, _Docs_, _Bugfixes_, _Security_, etc.). Take a look at previous release notes for guidance and try to keep it consistent.
2. Submit a pull request with these changes only and use the `"Cleanup release notes for X.X.X release"` template for the pull request title. ridgeplot uses the [SemVer](https://semver.org/) (`MAJOR.MINOR.PATCH`) versioning standard. You can determine the latest release version by running `git describe --tags --abbrev=0` on the `main` branch. Based on this, you can determine the next release version by incrementing the MAJOR, MINOR, or PATCH. More on this on the next section. For now, just make sure you merge this pull request into the `main` branch before continuing.
3. Use the [bumpversion](https://github.com/peritus/bumpversion) utility to bump the current version. This utility will automatically bump the current version, and issue a relevant commit and git tag. E.g.,
```shell
Expand Down
2 changes: 1 addition & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ commands =
python "bin/open_in_browser.py" "docs/build/html/index.html"

[testenv:release-notes]
description = extract release notes from CHANGES.md
description = extract release notes from docs/reference/changelog.md
skip_install = true
deps =
markdown-it-py
Expand Down

0 comments on commit b610a50

Please sign in to comment.