Skip to content

Commit 1a77eaf

Browse files
committed
chore: new AGENTS.md with release instructions
1 parent 776ba1f commit 1a77eaf

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,19 @@ ADAPTER=tiny HTTPBIN=httpbin.bemisc.com pytest
3232
- Prefer `item not in list` over `not item in list`
3333
- Prefer `item == None` over `item is None`
3434

35+
## New Release
36+
37+
To create a new release follow the following steps:
38+
39+
- Make sure that both the tests pass and the code formatting are valid.
40+
- Increment (look at `CHANGELOG.md` for semver changes) the `VERSION` value in `src/quorum/info.py`.
41+
- Move all the `CHANGELOG.md` Unreleased items that have at least one non empty item the into a new section with the new version number and date, and then create new empty sub-sections (Added, Changed and Fixed) for the Unreleased section with a single empty item.
42+
- Create a new set of entries in `doc/changelog.rst` with the same entries and the ones included in the new version in `CHANGELOG.md`.
43+
- Create a commit with the following message `version: $VERSION_NUMBER`.
44+
- Push the commit.
45+
- Create a new tag with the value fo the new version number `$VERSION_NUMBER`.
46+
- Create a new release on the GitHub repo using the Markdown from the corresponding version entry in `CHANGELOG.md` as the description of the release and the version number as the title. Do not include the title of the release (version and date) in the description.
47+
3548
## License
3649

3750
Quorum Extensions for Flask is licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/).

0 commit comments

Comments
 (0)