Description

This workflow manages releases cycle and releavant version in files.

Features

Let's start with adding a new release, i.e. 1.5.0 . Firstly, you need to create a new branch, named release/1.5.0

git branch release/1.5.0

Make some changes, or if you do not do anything (--allow-empty means you don't have to make changes), just issue

git commit -m "..." --allow-empty

Then push to GitHub

git push -u origin release/1.5.0

Now this workflow will run,

• pull from this branch,
• edit version in hyfetch/constants.py,
• make tags on version,
• commit and push to repo,
• deploy to PYPI as prerelease.

When running first time it will set version to 1.5.0rc1 . And if you don't get satisfied with this prerelease, you can edit this branch locally, and commit again. Once the second push is done, it will run again with version set to 1.5.0rc2 , and do the work above.

After you've made all tests and believe it's ready for release,change something or not, and make a commit with message start with release . For example:

git commit -m "release: foo" --allow-empty

This workflow will run again and

• pull from this branch,
• edit version in hyfetch/constants.py , package.json and neofetch
• edit README.md and change head starts with ### Unpublished to ### 1.5.0
• merge changes into parent branch (where this branch is created),
• use contents below ### 1.5.0 to be the release changelog,
• publish release.

TODO

Add your PYPI api token to secrets PYPI_API_TOKEN and GitHub user api token to GITHUB_API_TOKEN