Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release automation for docs #696

Merged
merged 8 commits into from
Aug 24, 2023
Merged

Conversation

willdavsmith
Copy link
Contributor

@willdavsmith willdavsmith commented Aug 21, 2023

Thank you for helping make the Radius documentation better!

Please follow this checklist before submitting:

  • Read the contribution guide
  • Commands include options for Linux, MacOS, and Windows within codetabs
  • New file and folder names are globally unique
  • Page references use shortcodes instead of markdown or URL links
  • Images use HTML style and have alternative text
  • Places where multiple code/command options are given have codetabs

In addition, please fill out the following to help reviewers understand this pull request:

Description

Auto-generated description

🤖 Generated by Copilot at 2a9e558

Summary

🚀📝🧪

This pull request adds scripts and a workflow to automate the release process of the docs website for different versions of Radius. It allows the user to specify a version number and creates a corresponding release branch and default branch for the docs repository. It also validates the version number and updates the configuration and content files accordingly.

release-docs.sh
Automates website updates
A winter blossom

Walkthrough

  • Add a GitHub workflow to manually release the docs website for a given version of Radius (link)
  • Validate the version number with the validate_semver.py script (link)
  • Add a script to automate the release process of the docs website (link)
  • Add a script to validate the version number format (link)

Issue reference

@willdavsmith willdavsmith requested a review from a team as a code owner August 21, 2023 20:12
@github-actions
Copy link

github-actions bot commented Aug 21, 2023

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-696.westus2.azurestaticapps.net
Password: Radiu$1234

1 similar comment
@github-actions
Copy link

github-actions bot commented Aug 21, 2023

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-696.westus2.azurestaticapps.net
Password: Radiu$1234

youngbupark
youngbupark previously approved these changes Aug 21, 2023
Copy link
Contributor

@youngbupark youngbupark left a comment

Choose a reason for hiding this comment

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

lgtm but please the review from @AaronCrawfis :)

./docs/.github/scripts/release-docs.sh ${{ inputs.version }}
- name: Change the default branch
run: |
gh api \
Copy link
Contributor

Choose a reason for hiding this comment

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

Will the default Actions token have the ability to change the default branch, or will we have to use GH_RAD_CI_BOT_PAT?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

good call, fixed to add this to the env

CHART_VERSION_STRING_REPLACEMENT="chart_version = \"${VERSION_NUMBER}\""
awk -v REPLACEMENT="${CHART_VERSION_STRING_REPLACEMENT}" '{gsub(/chart_version = \"[^\n]+\"/, REPLACEMENT); print}' docs/config.toml > docs/config.toml.tmp
mv docs/config.toml.tmp docs/config.toml

Copy link
Contributor

Choose a reason for hiding this comment

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

Can we update github_branch to the new branch name as well please?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updated

@github-actions
Copy link

github-actions bot commented Aug 22, 2023

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-696.westus2.azurestaticapps.net
Password: Radiu$1234

@github-actions
Copy link

github-actions bot commented Aug 22, 2023

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-696.westus2.azurestaticapps.net
Password: Radiu$1234

@github-actions
Copy link

github-actions bot commented Aug 22, 2023

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-696.westus2.azurestaticapps.net
Password: Radiu$1234

AaronCrawfis
AaronCrawfis previously approved these changes Aug 23, 2023
@github-actions
Copy link

github-actions bot commented Aug 23, 2023

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-696.westus2.azurestaticapps.net
Password: Radiu$1234

@willdavsmith willdavsmith merged commit b3defb4 into edge Aug 24, 2023
8 checks passed
@willdavsmith willdavsmith deleted the willdavsmith/docs-release-automation branch August 24, 2023 18:11
willdavsmith added a commit that referenced this pull request Sep 14, 2023
* Adding workflow to release docs

* bug

* bug

* Adding github token

* Adding replacement

* nit

* Adding gh email and user as env variables

(cherry picked from commit b3defb4)
willdavsmith added a commit that referenced this pull request Sep 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants