Release-it
Prerequisites
Required environment variable: Gitlab Personal Access Token
You will need a personal access token with api scope.
Add this to your environment via your .zshrc, .profile or whatever you are using as GITLAB_TOKEN.
Or export the environment variable directly into your session.
export GITLAB_TOKEN=XXXXXXZZZZZZZZZZ
Required environment variable: EDITOR or VISUAL
In the interactive mode you will be asked to verify / edit your changelog. This opens your editor that is defined in VISUAL or EDITOR environment variables.
If you want to use Microsoft Visual Studio Code for this:
export VISUAL="code -w"
CHANGELOG.md File
To use this workflow you will need to add a keep-a-changelog style changelog to your project.
You can copy the template CHANGELOG-template.md to CHANGELOG.md.
Git Tags
For existing tags/releases you need to add a version section for each tag or release manually to your changelog, according to the keep-a-changelog specifications.
How to use
You need to have the latest stable node installed.
To execute in interactive mode:
npx --package=@open-xchange/release-it@latest -- release-it-ox
For convenience add to package.json
"scripts": {
"release": "npx --package=@open-xchange/release-it@latest -- release-it-ox"
}
You can then type and follow the prompt:
yarn release
Thats all!
Notes
- Temporarily we are using a fork of autochange-log which is located here: https://github.com/open-xchange/auto-changelog
TODO
- Support for apps that are to be released only as NPM modules
- Support for a non-interative mode for use in pipelines e.g.
- Support for different git tag patterns