Skip to content

chore: release docs update plus auto publish docs site#5436

Merged
caseyisonit merged 10 commits intomainfrom
caseyisonit/realse-docs-update-auto-publish-docs-site
May 6, 2025
Merged

chore: release docs update plus auto publish docs site#5436
caseyisonit merged 10 commits intomainfrom
caseyisonit/realse-docs-update-auto-publish-docs-site

Conversation

@caseyisonit
Copy link
Copy Markdown
Contributor

@caseyisonit caseyisonit commented May 6, 2025

Description

  • Updates the RELEASE_PROCESS.md doc with notes from the last release.
  • Includes some improvements to auto-publish the doc site when the docs commit type merges into main
  • Corrects a label in the auto-update action to watch for ready-for-review.
  • PR template improvements since this is the first one using it.

Motivation and context

  • The release process is now fully documented, including prerequisites, so anyone can get set up and do a release
  • Docs site publishing regularly is a massive low-hanging fruit improvement for our consumers. This will now ensure accessibility doc improvements are shipping quickly and providing value instantly.
  • @castastrophe introduced a super cool action a while ago, and I noticed the label was incorrect. This will now help keep branches up to date with the main that are ready for review.
  • Better PR drafting experience

Related issue(s)

  • NA

Author's checklist

  • I have read the CONTRIBUTING and PULL_REQUESTS documents.
  • I have reviewed at the Accessibility Practices for this feature, see: Aria Practices
  • I have added automated tests to cover my changes.
  • I have included a well-written changeset if my change needs to be published.
  • I have included updated documentation if my change required it.

Reviewer's checklist

Manual review test cases

  • Read the RELEASE_PROCESS.md and make sure it reads clearly

@caseyisonit caseyisonit requested a review from a team as a code owner May 6, 2025 02:21
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 6, 2025

⚠️ No Changeset found

Latest commit: fc46d68

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Comment thread .github/PULL_REQUEST_TEMPLATE.md
Comment thread .github/PULL_REQUEST_TEMPLATE.md
Comment thread .github/PULL_REQUEST_TEMPLATE.md
Comment thread .github/PULL_REQUEST_TEMPLATE.md
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 6, 2025

Branch preview

Review the following VRT differences

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

Comment thread .github/workflows/pr-update.yml Outdated
limit: 50
exclude_labels: blocked,wip
include_labels: in-review,ready-for-merge
include_labels: ready-for-review,ready-for-merge
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

this is the label we use in swc repo, @castastrophe let me know if I'm misunderstanding the word label here :)

Copy link
Copy Markdown
Contributor

@blunteshwar blunteshwar May 6, 2025

Choose a reason for hiding this comment

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

nit
what will happen with this change?

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.

Yeah, that makes sense to me. That utility will auto-rebase PRs with either of those labels present.

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.

Honestly the utility can be a bit aggressive when used so I generally suggest a separate flag for it like "auto-update" to make sure you're opting into it specifically.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@castastrophe should we change the label and update our PR docs to include a section about updating base?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

would love to better understand what you mean when you say "aggressive", maybe we sync in slack or huddle?

Comment thread .github/workflows/publish.yml
@caseyisonit caseyisonit added Component:Tooling Issue or PR dealing with scripts, workflows, automation, etc. Component prefix is for Jira Component:Documentation Issues or PRs involving changes to docs or docs website. Component prefix is for Jira integration. Status:Ready for review PR ready for review or re-review. labels May 6, 2025
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 6, 2025

Tachometer results

Currently, no packages are changed by this PR...

Copy link
Copy Markdown
Contributor

@castastrophe castastrophe left a comment

Choose a reason for hiding this comment

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

This looks so great! One nit, if there's only 1 item in the list, we can probably just list it without the indent.

Comment thread RELEASE_PROCESS.md Outdated
Comment thread RELEASE_PROCESS.md Outdated
Copy link
Copy Markdown
Contributor

@blunteshwar blunteshwar left a comment

Choose a reason for hiding this comment

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

Great work!
Lets go!:rocket:

@caseyisonit
Copy link
Copy Markdown
Contributor Author

the smoke test isnt working because my branch name is too long, was verified in #5439

@caseyisonit caseyisonit merged commit 2ce369b into main May 6, 2025
23 of 24 checks passed
@caseyisonit caseyisonit deleted the caseyisonit/realse-docs-update-auto-publish-docs-site branch May 6, 2025 19:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component:Documentation Issues or PRs involving changes to docs or docs website. Component prefix is for Jira integration. Component:Tooling Issue or PR dealing with scripts, workflows, automation, etc. Component prefix is for Jira Status:Ready for review PR ready for review or re-review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants