Backport documentation publishing improvements #1880
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Simplify documentation publishing logic Split into two pipelines, one that runs on main and one that runs on release branches and tags. Use `has-matching-release-tag` workflow to determine whether to release documentation on release branch and tags. `has-matching-release-tag` is documented in https://github.com/grafana/grafana-github-actions/blob/main/has-matching-release-tag/action.yaml Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Remove script no longer used for documentation releases Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Add missing clone step for the website-sync action Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Update RELEASE instructions to reflect automated docs publishing Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Remove conditional from website clone for next publishing Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Checkout the repository as part of the documentation sync I assumed this was already done but the GitHub docs confirm that it is required. https://docs.github.com/en/github-ae@latest/actions/using-workflows/about-workflows#about-workflows Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Allow manual triggering of workflow Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
TIL that if you edit the workflow in the GitHub UI, it will lint your workflow file and make sure that all the keys conform to the schema.
jdbaldry
changed the title
osg-grafana
reviewed
May 18, 2022
| steps: | ||
| - name: "Check out code" | ||
| uses: "actions/checkout@v3" | ||
| - name: "Build website" |
There was a problem hiding this comment.
Is this build website or build technical documentation for the website?
There was a problem hiding this comment.
Does it make more or less sense for this to be "Build technical documentation target for website"?
osg-grafana
approved these changes
May 18, 2022
| @@ -104,10 +105,6 @@ To publish a stable release: | |||
| - Temporarily enable "Allow merge commits" option in "Settings > Options" | |||
There was a problem hiding this comment.
Suggested change
| - Temporarily enable "Allow merge commits" option in "Settings > Options" | |
| - From **Settings** > **Options**, temporarily enable the **Allow merge commits** option. |
| @@ -104,10 +105,6 @@ To publish a stable release: | |||
| - Temporarily enable "Allow merge commits" option in "Settings > Options" | |||
| - Locally merge the `merge-release-X.Y-to-main` branch into `main`, and push the changes to `main` back to GitHub. This doesn't break `main` branch protection, since the PR has been approved already, and it also doesn't require removing the protection. | |||
There was a problem hiding this comment.
Suggested change
| - Locally merge the `merge-release-X.Y-to-main` branch into `main`, and push the changes to `main` back to GitHub. This doesn't break `main` branch protection, since the PR has been approved already, and it also doesn't require removing the protection. | |
| - Locally merge the `merge-release-X.Y-to-main` branch into `main`, and push the changes to `main` back to GitHub. This doesn't break `main` branch protection because the PR has been approved already, and it also doesn't require removing the protection. |
|
@osg-grafana @johannaratliff This is a cherry-pick PR. We should not do any change here. Changes must be done in |
johannaratliff
approved these changes
May 20, 2022
|
Going to merge it with a merge commit. |
pracucci
deleted the
jdb/2022-05-backport-documentation-publishing-improvements
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Backports the documentation fixes from main that allow documentation releases on release branches.