aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn MacFarlane <[email protected]>2025-04-07 10:33:41 -0700
committerJohn MacFarlane <[email protected]>2025-04-07 10:33:41 -0700
commitdd057deeefa85088baa598d4acf8214658f369f0 (patch)
tree8c57ec2c2a81526120d4982b25a5b0901b9ee154
parent109d13d143fdfc33b9b13f8fc1be2f65f8f35ec0 (diff)
Make RELEASE-CHECKLIST an org file.
-rw-r--r--.gitignore2
-rw-r--r--RELEASE-CHECKLIST34
-rw-r--r--RELEASE-CHECKLIST.org53
3 files changed, 54 insertions, 35 deletions
diff --git a/.gitignore b/.gitignore
index 2540f7300..b8cbbac00 100644
--- a/.gitignore
+++ b/.gitignore
@@ -27,7 +27,7 @@
!Makefile
!README.md
!README.template
-!RELEASE-CHECKLIST
+!RELEASE-CHECKLIST.org
!SECURITY.md
!Setup.hs
!cabal.project
diff --git a/RELEASE-CHECKLIST b/RELEASE-CHECKLIST
deleted file mode 100644
index ed737720f..000000000
--- a/RELEASE-CHECKLIST
+++ /dev/null
@@ -1,34 +0,0 @@
-[ ] Bump version number for pandoc and pandoc-cli
-[ ] Sync pandoc version in pandoc-cli
-[ ] Update MANUAL.txt date
-[ ] Finalize changelog
-[ ] make prerelease
-[ ] Update AUTHORS (make authors LASTRELEASE=x.y.z)
-[ ] Run release candidate workflow manually on GitHub
-[ ] Run release candidate workflows manually on cirrus-ci.com
-[ ] If it builds successfully, download artifacts from GitHub, cirrus-ci.com
- (Windows and intel mac from GitHub, linux amd64 and arm64 and m1 mac
- from cirrus)
-[ ] Use 'make' in macos and windows artifacts to sign code
-[ ] make update-website
-[ ] Tag release in git:
- - use X.Y for pandoc
- - pandoc-cli-X.Y
- - if needed: pandoc-server-X.Y
- - if needed: pandoc-lua-engine-X.Y
-[ ] Upload packages to Hackage:
- - pandoc
- - pandoc-cli
- and if changed:
- - pandoc-server
- - pandoc-lua-engine
-[ ] make pandoc-templates
- cd ../pandoc-templates
- git tag REL
- git push
- git push --tags
-[ ] Add release on github (use 'make changes_github' and upload files)
-[ ] Copy deb to server, install it
-[ ] If needed, sh tools/build-and-upload-api-docs.sh
-[ ] Announce on pandoc-announce, pandoc-discuss
-
diff --git a/RELEASE-CHECKLIST.org b/RELEASE-CHECKLIST.org
new file mode 100644
index 000000000..fd849e424
--- /dev/null
+++ b/RELEASE-CHECKLIST.org
@@ -0,0 +1,53 @@
+:PROPERTIES:
+:header-args: :var VERSION="X.Y.Z"
+:END:
+** pandoc 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-server/pandoc-server.cabal]] - bump version number if appropriate
+*** TODO Update [[./MANUAL.txt]] date
+*** TODO Finalize [[./changelog.md]]
+*** TODO prerelease checks
+#+begin_src sh
+make prerelease
+#+end_src
+*** TODO Update [[./AUTHORS.md]]
+#+begin_src sh
+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
+*** TODO If it builds successfully, download artifacts from GitHub, cirrus-ci.com
+ (Windows and intel mac from GitHub, linux amd64 and arm64 and m1 mac
+ from cirrus)
+*** TODO Use 'make' in macos and windows artifacts to sign code
+*** TODO Update website
+#+begin_src sh
+make update-website
+#+end_src
+*** TODO Tag release in git:
+ - use X.Y for pandoc
+ - pandoc-cli-X.Y
+ - if needed: pandoc-server-X.Y
+ - if needed: pandoc-lua-engine-X.Y
+*** TODO Upload packages to Hackage:
+ - pandoc
+ - pandoc-cli
+ and if changed:
+ - pandoc-server
+ - pandoc-lua-engine
+*** TODO make pandoc-templates
+#+begin_src sh
+make pandoc-templates
+pushd ~/src/pandoc-templates
+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 Announce on pandoc-announce, pandoc-discuss
+