chore: release docs update plus auto publish docs site #5436
Conversation
|
| @@ -1,6 +1,8 @@ | |||
| <!--- Provide a general summary of your changes in the Title above --> | |||
| <!--- PR titles should follow conventional commit and should include commit type as defined in in the PULL_REQUESTS guide --> | |||
| <!--- Conventional commit docs can be referenced here: https://www.conventionalcommits.org/en/v1.0.0/#summary --> | |||
There was a problem hiding this comment.
this is linked in PULL_REQUESTS
| <!--- Conventional commit docs can be referenced here: https://www.conventionalcommits.org/en/v1.0.0/#summary --> | ||
| <!--- | ||
| - Following conventional commit format, provide a general summary of your changes in the title above. | ||
| - Acceptable commit types in order of severity (high to low): feat, fix, docs, style, chore, perf, and test. Commit types are defined in PULL_REQUESTS.md. |
There was a problem hiding this comment.
Included a list of acceptable types so its easier to know which ones we use
| <!--- | ||
| - Following conventional commit format, provide a general summary of your changes in the title above. | ||
| - Acceptable commit types in order of severity (high to low): feat, fix, docs, style, chore, perf, and test. Commit types are defined in PULL_REQUESTS.md. | ||
| - For example,`type(component): general summary` |
There was a problem hiding this comment.
example structure for clarity
| - Include links and manual steps for how the reviewer should go through to verify your changes. | ||
| - Be sure to include all areas of the codebase that might be affected. Any components that use these changes for a dependency should be cross-checked for regressions. | ||
| - For example, changes to Menu Item will affect Picker, Menu, and Action Menu. | ||
| --> |
There was a problem hiding this comment.
reformatted for readability in PR drafting and consistency
Branch previewReview the following VRT differencesWhen 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 |
| @@ -23,4 +23,4 @@ jobs: | |||
| include_drafts: false | |||
| limit: 50 | |||
| exclude_labels: blocked,wip | |||
| include_labels: in-review,ready-for-merge | |||
| include_labels: ready-for-review,ready-for-merge | |||
There was a problem hiding this comment.
this is the label we use in swc repo, @castastrophe let me know if I'm misunderstanding the word label here :)
| # Run the job if manually triggered or if the commit message includes '#publish' & the check suite has passed | ||
| if: github.event_name == 'workflow_dispatch' || contains(github.event.head_commit.message, '#publish') | ||
| # Run the job if manually triggered or if the commit message includes '#publish' & the check suite has passed or if the commit message includes 'docs' and the check suite has passed | ||
| if: github.event_name == 'workflow_dispatch' || contains(github.event.head_commit.message, '#publish') || contains(github.event.head_commit.message, 'docs') |
There was a problem hiding this comment.
this will publish the docs site if the docs commit type is included in the merge message
Tachometer resultsCurrently, no packages are changed by this PR... |
Description
docscommit type merges intomainready-for-review.Motivation and context
Related issue(s)
Author's checklist
Reviewer's checklist
Manual review test cases