Skip to content

Commit

Permalink
Update order of pushing tags
Browse files Browse the repository at this point in the history
  • Loading branch information
shansfolder committed Jan 12, 2018
1 parent 4f29685 commit 8055829
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,16 @@ The flow would then look like follows:
1. :code:`bumpversion (patch|minor)`
2. :code:`make docs`
3. :code:`git add CHANGELOG.*`
4. :code:`git commit -m "updated changelog"`
5. :code:`git push --follow-tags`
4. :code:`git commit -m "update changelog"`
5. :code:`git push`
6. :code:`git push --tags`

You can then check if the triggered Travis CI job is tagged (the name should be eg. 'v1.2.3' instead of 'master').

Note that it has a flaw that changelog generator will not put the changes of the current release,
because it reads the commit messages from git remote.

TODO: One solution could be to discard the automatic changelog generator and manually write the changelog before step 1,
ToDo: One solution could be to discard the automatic changelog generator and manually write the changelog before step 1,
and then config `make docs` to use this changelog file.


Expand Down

0 comments on commit 8055829

Please sign in to comment.