satysfi-base
satysfi-base copied to clipboard
automate release engineering
I'd like following points to be included in this issue
- Provide documents of versioning scheme
- Provide instructions of how to release a new version
I leave some comments here for future documenting:
Provide documents of versioning scheme
We are currently (relatively strictly) following the semver. OTOH we have not (yet) adopted keep a changelog.
Provide instructions of how to release a new version
My personal workflow is as follows (taken by the history command):
node scripts/release.js 1.2.1
(...get approval from other contributors and merge it at github...)
git pull
git tag -a 1.2.1
git push --tags
opam publish --repo na4zagin3/satyrographos-repo
After some investigation I found that opam-publish retrieves a github access token from ~/.opam/plugins/opam-publish/na4zagin3%satyrographos-repo.token whose content is usual 40-byte ascii token of github.
On every run of a github action an access token is stored in an environment variable called GITHUB_TOKEN, so perhaps saving the token to ~/.opam/plugins/opam-publish/na4zagin3%satyrographos-repo.token in github actions lets opam-publish work in actions.
https://github.com/actions-ecosystem/action-release-label