Skip to content

Update "Making Release" docs post 6.7#11642

Merged
ofahimIQSS merged 5 commits into
developfrom
docs-making-releases-post-6.7
Jul 23, 2025
Merged

Update "Making Release" docs post 6.7#11642
ofahimIQSS merged 5 commits into
developfrom
docs-making-releases-post-6.7

Conversation

@pdurbin

@pdurbin pdurbin commented Jul 16, 2025

Copy link
Copy Markdown
Member

What this PR does / why we need it:

@ofahimIQSS and I are noticing little things to fix.

Preview at https://dataverse-guide--11642.org.readthedocs.build/en/11642/developers/making-releases.html

@pdurbin pdurbin moved this to In Progress 💻 in IQSS Dataverse Project Jul 16, 2025
@pdurbin pdurbin changed the title Doc updates to "Making Release" page post 6.7 Update "Making Release" docs post 6.7 Jul 16, 2025
@pdurbin pdurbin moved this from In Progress 💻 to In Review 🔎 in IQSS Dataverse Project Jul 16, 2025
@pdurbin pdurbin added the Size: 0.5 A percentage of a sprint. 0.35 hours label Jul 16, 2025
@cmbz cmbz added FY26 Sprint 1 FY26 Sprint 1 (2025-07-02 - 2025-07-16) FY26 Sprint 2 FY26 Sprint 2 (2025-07-16 - 2025-07-30) labels Jul 17, 2025
@@ -84,7 +84,8 @@ The task at or near release time is to collect these snippets into a single file
- Create a branch, add a .md file for the release (ex. 5.10.1 Release Notes) in ``/doc/release-notes`` and write the release notes, making sure to pull content from the release note snippets mentioned above. Snippets may not include any issue number or pull request number in the text so be sure copy the number from the filename of the snippet into the final release note.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Create a branch, add a .md file for the release (ex. 5.10.1 Release Notes) in ``/doc/release-notes`` and write the release notes, making sure to pull content from the release note snippets mentioned above. Snippets may not include any issue number or pull request number in the text so be sure copy the number from the filename of the snippet into the final release note.
- Create a branch, add a .md file for the release (ex. 5.10.1 Release Notes) in ``/doc/release-notes`` and write the release notes, making sure to pull content from the release note snippets mentioned above. Snippets may not include any issue number or pull request number in the text so be sure to copy the number from the filename of the snippet into the final release note.

minor typo updates
Comment thread doc/sphinx-guides/source/developers/making-releases.rst Outdated
@pdurbin pdurbin moved this from In Review 🔎 to Ready for QA ⏩ in IQSS Dataverse Project Jul 23, 2025
@pdurbin pdurbin moved this from Ready for QA ⏩ to In Review 🔎 in IQSS Dataverse Project Jul 23, 2025
@pdurbin

pdurbin commented Jul 23, 2025

Copy link
Copy Markdown
Member Author

The latest commits look good to me.

Let me mention a couple things I brought up in Slack, maybe for the future:

  • We could add a step at the end like "create a copy of the master branch and make sure you can merge the develop branch into it cleanly, without merge conflicts". To be forewarned of the trouble we saw yesterday. See also Merge the “develop” branch into “master” for 6.7 Release #11647 (comment)
  • We could also add an early step like "build the guides from the develop branch to make sure Jenkins is ready to build from the master branch, when the time comes". This would help us get ahead of the doc build problem we saw.

@ofahimIQSS what do you think? Do you want me to add these?

@ofahimIQSS ofahimIQSS left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

approving - typo fixes

@github-project-automation github-project-automation Bot moved this from In Review 🔎 to Ready for QA ⏩ in IQSS Dataverse Project Jul 23, 2025
@ofahimIQSS ofahimIQSS moved this from Ready for QA ⏩ to QA ✅ in IQSS Dataverse Project Jul 23, 2025
@ofahimIQSS

Copy link
Copy Markdown
Contributor

everything checks out - merging

@ofahimIQSS
ofahimIQSS merged commit 1507805 into develop Jul 23, 2025
8 checks passed
@ofahimIQSS
ofahimIQSS deleted the docs-making-releases-post-6.7 branch July 23, 2025 17:03
@github-project-automation github-project-automation Bot moved this from QA ✅ to Merged 🚀 in IQSS Dataverse Project Jul 23, 2025
@ofahimIQSS ofahimIQSS removed their assignment Jul 23, 2025
@pdurbin pdurbin added this to the 6.8 milestone Jul 23, 2025
@scolapasta scolapasta moved this from Merged 🚀 to Done 🧹 in IQSS Dataverse Project Jul 24, 2025
@cmbz cmbz added the FY26 Sprint 4 FY26 Sprint 4 (2025-08-13 - 2025-08-27) label Aug 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

FY26 Sprint 1 FY26 Sprint 1 (2025-07-02 - 2025-07-16) FY26 Sprint 2 FY26 Sprint 2 (2025-07-16 - 2025-07-30) FY26 Sprint 4 FY26 Sprint 4 (2025-08-13 - 2025-08-27) Size: 0.5 A percentage of a sprint. 0.35 hours

Projects

Status: Done 🧹

Development

Successfully merging this pull request may close these issues.

4 participants