Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add release workflow #15

Merged
merged 3 commits into from
Aug 15, 2022
Merged

Add release workflow #15

merged 3 commits into from
Aug 15, 2022

Conversation

Aleksanaa
Copy link

@Aleksanaa Aleksanaa commented Aug 15, 2022

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

This commit make it merge to parent branch instead of `master` branch, i.e. you are working on a branch called `refactor` and making a branch `release/2.0`, changes will be applied to `refactor` instead of `master`.
add --all so final commit to release branch will also update
@hykilpikonna hykilpikonna merged commit 821b306 into hykilpikonna:master Aug 15, 2022
aaronfranke pushed a commit to aaronfranke/hyfetch that referenced this pull request Jan 8, 2023
teohhanhui added a commit to teohhanhui/hyfetch that referenced this pull request Jul 7, 2024
Implement recolored ascii output
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants