unbeatable101
/
iris
mirror of https://github.com/Calamitous/iris.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add section to docs on releases

This commit is contained in:
Eric B. Budd 2022-12-25 23:57:51 -06:00 committed by Eric Budd
parent 94ccc65647
commit f046b1a436
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -14,6 +14,7 @@ Iris is strictly text-based, requiring no GUI or web servers.
* [Text Features/Markup](#text-featuresmarkup)
* [Philosophy](#philosophy)
* [Tests](#tests)
* [Cutting A Release](#cutting-a-release)
* [Technical Bits](#technical-bits)
* [License](#license)
@ -636,6 +637,28 @@ Finished in 0.107785s, 612.3294 runs/s, 677.2734 assertions/s.
You have skipped tests. Run with --verbose for details.
```
## Cutting A Release
### Prep
* Make all updates in an appropriately named branch. (ie. `1.1.2`)
* Make sure all commits are clean.
* Make sure tests pass.
### Updates
* Change version number in `iris.rb`
* Change version numbers in documentation `README.md`
* Add new version and details to `CHANGELOG`
* Create new commit for release (Named "Bump Iris version to 1.1.2" or similar)
### Make the Sausage
* Push the branch
* `git push origin`
* Merge the branch (Fast-forward only, for a linear commit history)
* Tag the release
* `git tag 1.1.2`
* Push the tags
* `git push origin --tags`
## Technical Bits
* [Dependencies](#dependencies)