Skip to content

Conversation

ralfhandl
Copy link
Contributor

When we start a release, we add a line to the history table in Appendix A with the new release number and a "TBD" placeholder instead of the release date.

The adjust-release-branch.sh script now replaces the placeholder with the current date and shows the differences. One less thing to remember during a release.

  • no schema changes are needed for this pull request

@ralfhandl ralfhandl requested review from a team as code owners October 6, 2025 10:12
@ralfhandl ralfhandl added Housekeeping script Pull requests that update Bash or JavaScript code labels Oct 6, 2025
Copy link
Contributor

@mikekistler mikekistler left a comment

Choose a reason for hiding this comment

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

Looks good. 👍

cp EDITORS.md versions/$version-editors.md
mv src/oas.md versions/$version.md
sed "s/| TBD |/| $today |/g" src/oas.md > versions/$version.md
diff -w src/oas.md versions/$version.md
Copy link
Contributor

Choose a reason for hiding this comment

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

What is this diff command for? Could you maybe a comment here to explain?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It shows the lines that were changed by the sed command, which should only replace the "TBD" placeholder in the history table with the current (release) date. Just to be sure, and give the person preparing the release a hint if for some unfathomable reason the character sequence | TBD | appeared outside of the history table and should not have been changed.

@ralfhandl ralfhandl merged commit 0efdc65 into OAI:main Oct 6, 2025
2 checks passed
@ralfhandl ralfhandl deleted the main-adjust-release-history-date branch October 6, 2025 14:29
@lornajane
Copy link
Contributor

@ralfhandl I have the same question as @mikekistler on what's happening in this script.

Could you respond to the question and also update the CONTRIBUTING guide which had a set of manual steps to match the script, but the script is now out of sync.

@ralfhandl
Copy link
Contributor Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Housekeeping script Pull requests that update Bash or JavaScript code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants