dev docs - add more info about making pre-release and patch stable re…

…leases
quarto-dev · Jan 6, 2025 · 555a4d1 · 555a4d1
1 parent ac40068
commit 555a4d1
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/dev-docs/checklist-make-a-new-quarto-prerelease.md b/dev-docs/checklist-make-a-new-quarto-prerelease.md
@@ -0,0 +1,13 @@
+- [ ] ensure main is up to date and tests are passing on latest commit.
+- [ ] create new prerelease installers
+  - Click Actions -> Build Installers -> "Run Workflow" Dropdown Menu
+    - Select the main branch in the "Use workflow from..." dropdown
+    - Check "Pre-release" (or ensure it's checked)
+    - Check "Publish release" (or ensure it's checked)
+    - [ ] Click "Run Workflow"
+      - If workflow fails for some reason, re-run all jobs and not only failed jobs or trigger a new clean build from Actions -> Build Installers -> "Run Workflow" Dropdown Menu.
+        This is important because workflow commit an update to version.txt to main, and revert if cancelled or failure. A triggering a new workflow needs to re-run the configure step.
+- If everything went well:
+  - New release prerelease should be on Github at <https://github.com/quarto-dev/quarto-cli/releases>
+  - A new tag should be on main for the new prerelease version
+  - `version.txt` on main should have been updated by the workflow to the pre-release version just released: https://github.com/quarto-dev/quarto-cli/blob/main/version.txt
diff --git a/...klist-make-a-new-stable-quarto-release.md → ...-make-a-new-stable-quarto-release copy.md b/...klist-make-a-new-stable-quarto-release.md → ...-make-a-new-stable-quarto-release copy.md
@@ -8,6 +8,7 @@
     - Uncheck "Pre-release" (or ensure it's unchecked)
     - Check "Publish release" (or ensure it's checked)
     - [ ] Click "Run Workflow"
+      - If workflow fails for some reason, re-run all jobs and not only failed jobs or trigger a new clean build from Actions -> Build Installers -> "Run Workflow" Dropdown Menu
 - [ ] update release on pypi repo
   - Goto the [quarto-cli-pypi repo](https://github.com/quarto-dev/quarto-cli-pypi)
   - Update `version.txt` to be the version you'd like to publish and commit
@@ -24,4 +25,4 @@
       - **Publishing Production**: You may elect to publish to production pypyi by checking the `Production Release` option
         - Published to: <https://pypi.org/project/quarto-cli/>
     - Take a sip of tea ☕, bask in the glory of automation.
-- [ ] Update the stable changelog by moving entries to the "in previous release"
+- [ ] Update the stable changelog by moving entries from "In this release" to the "In previous releases" section