aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn MacFarlane <[email protected]>2025-04-07 11:53:36 -0700
committerJohn MacFarlane <[email protected]>2025-04-07 11:53:36 -0700
commit20b2e5ff4e398415359956143fac1cd7e6863898 (patch)
treec6919d39b9b5a7deadd4d2d5add2137e0b8566a8
parentdd057deeefa85088baa598d4acf8214658f369f0 (diff)
Add Makefile target `release-checkist`.
Make RELEASE-CHECKLIST.org into RELEASE-CHECKLIST-TEMPLATE.org. The makefile target will fill in version numbers in this template.
-rw-r--r--.gitignore2
-rw-r--r--Makefile6
-rw-r--r--RELEASE-CHECKLIST-TEMPLATE.org (renamed from RELEASE-CHECKLIST.org)32
3 files changed, 31 insertions, 9 deletions
diff --git a/.gitignore b/.gitignore
index b8cbbac00..6034d7c36 100644
--- a/.gitignore
+++ b/.gitignore
@@ -27,7 +27,7 @@
!Makefile
!README.md
!README.template
-!RELEASE-CHECKLIST.org
+!RELEASE-CHECKLIST-TEMPLATE.org
!SECURITY.md
!Setup.hs
!cabal.project
diff --git a/Makefile b/Makefile
index c78f440c2..2c3590563 100644
--- a/Makefile
+++ b/Makefile
@@ -322,6 +322,12 @@ help: ## display this help
@printf "%-16s%s\n" "REVISION" "$(REVISION)"
.PHONY: help
+release-checklist: release-checklist-${version}.org
+.PHONY: release-checklist
+
+release-checklist-${version}.org: RELEASE-CHECKLIST-TEMPLATE.org
+ sed -e 's/VERSION/${version}/g' $< > $@
+
hie.yaml: ## regenerate hie.yaml
gen-hie > $@
.PHONY: hie.yaml
diff --git a/RELEASE-CHECKLIST.org b/RELEASE-CHECKLIST-TEMPLATE.org
index fd849e424..62695ae16 100644
--- a/RELEASE-CHECKLIST.org
+++ b/RELEASE-CHECKLIST-TEMPLATE.org
@@ -1,11 +1,8 @@
-:PROPERTIES:
-:header-args: :var VERSION="X.Y.Z"
-:END:
-** pandoc release checklist
+** pandoc VERSION release checklist
*** TODO Check [[https://github.com/jgm/pandoc/issues?q=state%1Aopen%20label%3A%22priority%3Ahigh%22][priority-high tag]]
*** TODO [[./pandoc.cabal]] - bump version number
*** TODO [[./pandoc-cli/pandoc-cli.cabal]] - bump version number and sync pandoc version
-* TODO [[./pandoc-lua-engine/pandoc-lua-engine.cabal]] - bump version number if appropriate
+*** TODO [[./pandoc-lua-engine/pandoc-lua-engine.cabal]] - bump version number if appropriate
*** TODO [[./pandoc-server/pandoc-server.cabal]] - bump version number if appropriate
*** TODO Update [[./MANUAL.txt]] date
*** TODO Finalize [[./changelog.md]]
@@ -15,7 +12,7 @@ make prerelease
#+end_src
*** TODO Update [[./AUTHORS.md]]
#+begin_src sh
-make authors LASTRELEASE=$VERSION
+make authors LASTRELEASE=VERSION
#+end_src
*** TODO Run [[https://github.com/jgm/pandoc/actions/workflows/release-candidate.yml][release candidate workflow]] manually on GitHub
*** TODO Run [[https://cirrus-ci.com][release candidate workflows]] manually on cirrus-ci.com
@@ -42,12 +39,31 @@ make update-website
#+begin_src sh
make pandoc-templates
pushd ~/src/pandoc-templates
-git tag $VERSION
+git tag VERSION
git push
git push --tags
popd
#+end_src
-*** TODO Add release on github (use 'make changes_github' and upload files)
*** TODO Copy deb to server, install it
+*** TODO Add release on github (use 'make changes_github' and upload files)
+*** TODO create release announcement and add to GH release announcement
+#+begin_src sh :results none
+echo <<EOF >relann-VERSION
+I'm pleased to announce the release of pandoc VERSION,
+available in the usual places:
+
+Binary packages & changelog:
+https://github.com/jgm/pandoc/releases/tag/VERSION
+
+Source & API documentation:
+http://hackage.haskell.org/package/pandoc-VERSION
+
+Description of release.
+
+Any API changes.
+
+Thanks to all who contributed, especially new contributors ...
+EOF
+#+end_src
*** TODO Announce on pandoc-announce, pandoc-discuss