[latex3-commits] [latex3/fontspec] develop: added more comments in autorelease file (1112a99)

[github at latex-project.org]

Repository : https://github.com/latex3/fontspec
On branch  : develop
Link       : https://github.com/latex3/fontspec/commit/1112a991f223e627752f30cd3aa31406aa3030f5

>---------------------------------------------------------------

commit 1112a991f223e627752f30cd3aa31406aa3030f5
Author: Will Robertson <wspr81 at gmail.com>
Date:   Wed Feb 14 00:16:50 2024 +1030

    added more comments in autorelease file


>---------------------------------------------------------------

1112a991f223e627752f30cd3aa31406aa3030f5
 autorelease.lua | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/autorelease.lua b/autorelease.lua
index 25222e7..8dbb603 100755
--- a/autorelease.lua
+++ b/autorelease.lua
@@ -5,8 +5,16 @@
      AUTOMATON for performing CTAN releases
      ======================================
 
-     * Make sure changes are up to date with new version tag.
-     * Be in the `develop` branch, fully committed.
+     * Save the `main` branch for releases only; this allows hotfixes to releases to be 
+       organised easily with a minimal number of branches to keep things simple. 
+     * Changes over time go into the `develop` branch.
+     * Records of changes which deserve to be included in the release notes should be added
+       CHANGES.md. Follow the formatting of the file.
+     * The topmost entry of CHANGES.md is used to populate the new version number
+       (but the date will be updated automatically by the build script).
+     * The topmost entry of the CHANGES.md file is extracted and used in the git tagging
+       and in the CTAN release notes.
+     * To commence a release, be in the `develop` branch, fully committed.
      * This file will query a couple of times to make sure all is well.
      * If so, it sends the package off to CTAN and the `main` branch is rebased and tagged.
      * TODO: add Github release zip file as well.