Skip to content

Commit

Permalink
Modify changelog generator (#626)
Browse files Browse the repository at this point in the history
* modify changelog generator

* Changed the formatting of the changelog generator.

* update

* Update HOW_TO_CONTRIBUTE.md

* Update check-urls.yml

* remove unused dependency
  • Loading branch information
nwlandry authored Nov 26, 2024
1 parent 71b897f commit be8039e
Show file tree
Hide file tree
Showing 4 changed files with 454 additions and 2 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/check-urls.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ jobs:
# A comma-separated list of file types to cover in the URL checks
file_types: .md,.py,.rst,.ipynb

exclude_files: tools/*

# Choose whether to include file with no URLs in the prints.
print_all: false

Expand Down
2 changes: 1 addition & 1 deletion HOW_TO_CONTRIBUTE.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Please note we have a [code of conduct](/CODE_OF_CONDUCT.md), please follow it i
## New Version process

1. Make sure that the Github Actions workflow runs without any errors.
2. Using the `github-changelog` package (a dependency in the [release](requirements/release.txt) requirements file), run `changelog -m xgi-org xgi [last release tag]` to get the merged pull requests with their links. Paste this into the changelog file under a new heading and edit to make more legible. Associate a GitHub username with each pull request.
2. Run `python tools/generate_changelog.py -m xgi-org xgi [last release tag]` to get the merged pull requests with their links. Paste this into the changelog file under a new heading and edit to make more legible. Associate a GitHub username with each pull request.
3. Increase the version number in [\_\_init\_\_.py](xgi/__init__.py.py) to the new version agreed upon by the core developers. The versioning scheme we use is [SemVer](http://semver.org/).
4. Commit these changes.
5. Create a new release on GitHub by selecting "Releases", then clicking "Draft a new release". Click "Choose a tag" and type "v" followed by the version number and then click "Create new tag". The release title will be this same string. Paste the contents of the CHANGELOG into the "Describe this release" field. Click "Publish release". This will trigger a GitHub action that will publish the new version on PyPI.
Expand Down
1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,6 @@ release = [
"twine>=3.4",
"build>=1.2.1",
"wheel>=0.36",
"github-changelog",
]
test = [
"pytest>=7.2",
Expand Down
Loading

0 comments on commit be8039e

Please sign in to comment.