Skip to content

Commit 3c8fa10

Browse files
committed
Add release instructions
Signed-off-by: tdruez <[email protected]>
1 parent e318e64 commit 3c8fa10

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

RELEASE.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Release instructions for `DejaCode
2+
3+
### Automated release workflow
4+
5+
- Create a new `release-x.x.x` branch
6+
- Update the version in:
7+
- `setup.cfg`
8+
- `dejacode/__init__.py`
9+
- `CHANGELOG.rst` (set date)
10+
- Commit and push this branch
11+
- Create a PR and merge once approved
12+
- Tag and push that tag. This will trigger the `create-github-release.yml`
13+
and `publish-docker-image.yml` GitHub workflows:
14+
```
15+
VERSION=vx.x.x # <- Set the new version here
16+
git tag -a $VERSION -m ""
17+
git push origin $VERSION
18+
```
19+
- Review the GitHub release created by the workflow at
20+
https://github.com/aboutcode-org/dejacode/releases/

0 commit comments

Comments
 (0)