Skip to content

Commit a9fdaa9

Browse files
committed
Update publishing documentation
1 parent beddfe6 commit a9fdaa9

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,23 @@ $ tox
113113

114114
### Publishing
115115

116+
**Create**
117+
118+
1. Update the version number in `logfmter/__init__.py`.
119+
120+
2. Add an entry in `HISTORY.md`.
121+
122+
3. Commit the changes, tag the commit, and push the tags:
123+
124+
```sh
125+
$ git commit -am "v<major>.<minor>.<patch>"
126+
$ git tag v<major>.<minor>.<patch>
127+
$ git push --tags
128+
```
129+
130+
4. Convert the tag to a release in GitHub with the history
131+
entry as the description.
132+
116133
**Build**
117134

118135
```sh

0 commit comments

Comments
 (0)