Skip to content

Commit

Permalink
doc: add readme note about using latest tag if not on master
Browse files Browse the repository at this point in the history
Signed-off-by: Stephen L Arnold <[email protected]>
  • Loading branch information
sarnold committed Apr 15, 2022
1 parent 304b05f commit 22d2484
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,14 +50,17 @@ The canonical dogfood_ example is the `release.yml`_ and corresponding

.. _dogfood: http://catb.org/jargon/html/D/dogfood.html
.. _release.yml: https://github.com/sarnold/gitchangelog/blob/master/.github/workflows/release.yml#L58
.. _github release page: https://github.com/sarnold/gitchangelog/releases/tag/3.0.7
.. _github release page: https://github.com/sarnold/gitchangelog/releases/tag/3.0.9

Usage
=====

To enable the default release page changes file, create a .yml file under
.github/workflows with the following contents.

.. note:: Be sure to use the latest tag for this action if you're not
tracking the ``master`` branch.

Default configuration
---------------------

Expand Down

0 comments on commit 22d2484

Please sign in to comment.