Skip to content

Commit b4e2a57

Browse files
committed
Add release steps to the README
1 parent 3f35ed6 commit b4e2a57

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,3 +163,25 @@ If you submit a PR, please make sure it:
163163
* Doesn't break any existing tests
164164
* Adds new tests, if appropriate
165165
* Adds new documentation, if appropriate
166+
167+
### Release process
168+
169+
To build a new release of `notes`:
170+
171+
* `export NEW_VERSION="X.Y.Z"` (replacing X.Y.Z with the appropriate new version)
172+
* Run:
173+
```
174+
# Update the version number in the source
175+
sed -i -e "s/notes_version=.*/notes_version=\"$NEW_VERSION\"/g" notes
176+
177+
# Commit, tag & push the new version
178+
git add notes
179+
git commit -m $NEW_VERSION
180+
git tag $NEW_VERSION
181+
git push origin master --tags
182+
183+
# Mark this version as the latest release
184+
git checkout -B latest-release
185+
git push --force origin latest-release
186+
git checkout -
187+
```

0 commit comments

Comments
 (0)