Skip to content

Commit f627314

Browse files
authored
Improve release instructions in building.md
1 parent 76fcf3e commit f627314

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

Diff for: docs/building.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -214,17 +214,17 @@ To deploy a compiled JAR to Clojars, simply use the `deploy` alias which automat
214214
1. Update the version number in **project.clj**.
215215
2. Don't forget to add the new version with notes to **CHANGELOG.md**.
216216
3. Commit this change and tag it using `git tag -a v1.0.0 -m "Release v1.0.0"`, replacing *1.0.0* with your version number.
217-
4. Push your commit and tag it using `git push origin` followed by `git push origin v1.0.0` (again, replace *1.0.0* with your version number). Make sure that you push to the intermine repository, not just your fork!
217+
4. Push your commit and tag using `git push origin` followed by `git push origin v1.0.0` (again, replace *1.0.0* with your version number). Make sure that you push to the intermine repository, not just your fork!
218218
5. Deploy a new uberjar to Clojars with `lein deploy`.
219-
6. Push a new docker image to dockerhub.
219+
6. Push a new docker image to dockerhub (before pushing, you'll probably want to quickly test it locally).
220220
1. `lein uberjar`
221221
2. `docker build -t bluegenes .`
222222
3. `docker tag bluegenes intermine/bluegenes:1.0.0` (remember to use your correct version number)
223223
4. `docker tag bluegenes intermine/bluegenes:latest`
224224
5. `docker push intermine/bluegenes:1.0.0`
225225
6. `docker push intermine/bluegenes:latest`
226226
7. Deploy the latest release to dokku with `git push dokku dev:master`.
227-
8. [Draft a new Github release using the newly pushed tag](https://github.com/intermine/bluegenes/tags). You may leave the title/description blank as this is redundant with the changelog.
227+
8. [Draft a new Github release using the newly pushed tag](https://github.com/intermine/bluegenes/tags). It would be a good idea to follow the structure of previous releases; leave the title blank, and copy the description from what you added to the changelog. It's also useful to include links to the Clojars and Docker Hub releases.
228228

229229
# Troubleshooting
230230

0 commit comments

Comments
 (0)