From 22d2484fb4fe0519d5d1ece5464045619edb79bf Mon Sep 17 00:00:00 2001 From: Stephen L Arnold Date: Fri, 15 Apr 2022 10:56:21 -0700 Subject: [PATCH] doc: add readme note about using latest tag if not on master Signed-off-by: Stephen L Arnold --- README.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 520b980..b6b065e 100644 --- a/README.rst +++ b/README.rst @@ -50,7 +50,7 @@ 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 ===== @@ -58,6 +58,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 ---------------------