Infra: Create a GitHub Action to simplify release process
See original GitHub issueSituation
The current release process is described in the file release-procedure.md
. It’s a bit of cumbersome as a lot of things needs to be done manually.
Some ideas were already described in #186, this is specific for releases.
Proposed Solution
A GitHub Action seems a good method for this task. Some ideas what our Action could do:
- start the release process when a) a tag is created with adheres to the semantic version, or, b) a branch
release/VERSION
is merged into master. (not sure which one of this will be better or more feasible) - Verify if a branch
release/VERSION
matches with the__version__
variable insemver.py
? - Verify if the
CHANGELOG.rst
contains the correct version string? - Maybe use the branch
release/VERSION
to publish it to the TestPyPI first. - When the branch
release/VERSION
is merged into master (and only then!), do:- deploy it to PyPI
- create a tag (and use the content of the
CHANGELOG.rst
?) - update the “Releases” tab on our GitHub repo page
- …
It’s just a collection of rough ideas. I need to try it what’s possible and what is more difficult.
@scls19fr If you have more ideas or disagree with the above, just let me know so I can tailor this Action for our specific use case. 😃
Hint: I will try it out in my fork first so this repo will be kept clean.
See also
Possible GH Actions to investigate further:
Issue Analytics
- State:
- Created 4 years ago
- Comments:20 (20 by maintainers)
Top Results From Across the Web
Understanding GitHub Actions
GitHub Actions is a continuous integration and continuous delivery (CI/CD) platform that allows you to automate your build, test, and deployment pipeline. You ......
Read more >Using GitHub Actions to Create a Simple Test and Release ...
The final workflow file is relatively simple (just over 50 lines), but as you can see, this simplifies the process of testing and...
Read more >How we set up a release process with Github Actions - Rangle.io
Take a look at how we set up a release process for our Design System tracking tool using Github Actions.
Read more >GitHub Actions: built by you, run by us
Configuring the apps and services that make up your development cycle takes significant time and effort. GitHub Actions applies open source ...
Read more >Github Actions Security Best Practices
Github Actions enables users to run workflows, which are custom automated processes that can be set up in a repository to build, test, ......
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
Ok new API token named
TESTPYPI_SEMVER_UPLOAD_TOKEN
I tried to also add
k_bx
on TestPyPi (@k-bx on Github /k_bx
on PyPi) but he doesn’t seems to have an account there.You can find the token
TESTPYPI_SEMVER_UPLOAD_TOKEN
also in the GitHub Secrets tab.