kevin/asdf
1
Fork 0
mirror of https://github.com/asdf-vm/asdf.git synced 2024-11-15 01:28:17 -07:00
Code Issues Packages Projects Releases Wiki Activity

Create release README

Browse Source
This commit is contained in:
Trevor Brown 2019-03-24 16:26:03 -04:00
parent 96e010396a
commit cfa45ccc1a
2 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
release/README.md Normal file
View File

@ -0,0 +1,26 @@
# Release README
If you are a user you can ignore everything in this directory. This directory
contains documentation and scripts for preparing and tagging new versions of
asdf and is only used by asdf maintainers.
## Tagging Release Candidates
To tag release candidates
1. Update the CHANGELOG. Make sure it contains an entry for the version you are
tagging as well as a dev version things that come after the tag (e.g. a heading
with the format `<next-version>-dev`).
2. Run the tests and the linter - `bats test` and `lint.sh`.
3. Run the release script - `release/release_candidate.sh`
4. If the release script succeeds, push to Github. Make sure to use the correct
remote to push to the official repository
## Tagging Releases
1. Update the CHANGELOG. Make sure it contains an entry for the version you are
tagging as well as a dev version things that come after the tag (e.g. a heading
with the format `<next-version>-dev`).
2. Run the tests and the linter - `bats test` and `lint.sh`.
3. Run the release script - `release/release.sh`
4. If the release script succeeds, push to Github. Make sure to use the correct
remote to push to the official repository

0
release.sh → release/release.sh
View File