Skip to content

Commit 271a8d8

Browse files
Add README and License
Resolves #16.
1 parent eaaa9bd commit 271a8d8

2 files changed

Lines changed: 53 additions & 0 deletions

File tree

LICENSE

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Copyright 2020 Thomas Eizinger
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# GitFlow release workflow using GitHub actions
2+
3+
This repository contains GitHub workflows that allow for fully automated release as per the GitFlow conventions.
4+
You are welcome to use it for inspiration for your own release workflows or maybe even copying them verbatim if the fit your needs.
5+
6+
## Usage
7+
8+
If you are using the workflows as they are in this repository, there are only two manual steps for releasing a new version:
9+
10+
1. Create a ticket that is titled "Release version x.y.z" and label it with "release".
11+
2. Merge the PR that is created for you.
12+
13+
The automation will do the following things:
14+
15+
- Update your changelog with the new version
16+
- Change the version in the necessary manifest files
17+
- Tag the final release and create a GitHub release
18+
19+
## Design
20+
21+
I've written a blog post that describes the technical design in detail here:
22+
23+
The idea of these workflows is to automate all the tedious aspects of releases while still allowing manual intervention if necessary and control over crucial aspects.
24+
25+
I think I've achieved this by doing the following:
26+
27+
- The individual GitHub actions used are small and focused.
28+
29+
This allows you to adapt the workflows to your own needs.
30+
Ironically, this is what makes this whole repository not special.
31+
It just takes good ideas that are already out there and creates automation around them.
32+
33+
- You have full control over what the next version is.
34+
35+
There is no magic involved, only the tedious things are automated.
36+
You have full control over what is being released and under which version.
37+
38+
## Hall of fame
39+
40+
If you are using these workflow or got inspired by them to build something similar, feel free to add yourself to this list:
41+
42+
- BE THE FIRST ONE!
43+
44+
## License
45+
46+
MIT.

0 commit comments

Comments
 (0)