Update workflows to use actions that don't need organization secrets #1571
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
Each repository can only have 100 organization secrets and there are now more than 100 in our organization which causes inconsitent behavior. Some repositories don't have the secrets they need assigned. These composite actions use secrets stored in Vault that are available to all repositories. - `publish-technical-documentation-next.yml` has been tested with https://github.com/grafana/writers-toolkit/blob/main/.github/workflows/publish-technical-documentation.yml. - `publish-technical-documentation-release.yml` has been tested with https://github.com/grafana/backend-enterprise/blob/gem-release-2.13/.github/workflows/publish-technical-documentation-release.yml. There is some copy-paste involved in the creation of these workflows. Please check: For `publish-technical-documentation-next.yml`: - [ ] The `on.push` `branches` and `paths` filters are correct for your repository. - [ ] The `jobs.sync.if` repository matches your repository. - [ ] The `jobs.sync.steps[1].with.website_directory` matches the directory you publish to in the website repository. For `publish-technical-documentation-release.yml`: - [ ] The `on.push` `branches`, `tags`, and `paths` filters are correct for your repository. - [ ] The `jobs.sync.if` repository matches your repository. - [ ] The `jobs.sync.steps[1].with.release_tag_regexp` regular expression matches your tags and captures major, minor, and patch versions from those tags. - [ ] The `jobs.sync.steps[1].with.release_branch_regexp` regular expression matches your release branch names and captures major and minor versions from those branch names. - [ ] The `jobs.sync.steps[1].with.release_branch_with_patch_regexp` regular expression matches your release branch names if they were to include a patch version, and that it would capture major, minor, and patch versions from those branch names. - [ ] The `jobs.sync.steps[1].with.website_directory` matches the directory you publish to in the website repository. Signed-off-by: Jack Baldry <[email protected]>
jdbaldry
commented
Aug 28, 2024
ptodev
approved these changes
Sep 20, 2024
ptodev
reviewed
Sep 20, 2024
Comment on lines
+28
to
+29
| website_directory: content/docs/alloy | ||
| version_suffix: "" |
There was a problem hiding this comment.
I suppose this will update both content/docs/alloy/latest and, for example, content/docs/alloy/v1.2/ ?
There was a problem hiding this comment.
Sorry, late reply.
Short answer: yes.
Longer answer:
We actually publish only version directories and then the website derives "latest" from the highest published version directory. So content/docs/alloy/latest doesn't actually get updated but /docs/alloy/latest/ does.
jdbaldry
deleted the
jdb/2024-08-update-publish-workflows-to-avoid-org-secrets
branch
pbailhache
pushed a commit
to pbailhache/alloy
that referenced
this pull request
Oct 17, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
PR Description
Each repository can only have 100 organization secrets and there are now more than 100 in our organization which causes inconsitent behavior.
Some repositories don't have the secrets they need assigned.
These composite actions use secrets stored in Vault that are available to all repositories.
publish-technical-documentation-next.ymlhas been tested with https://github.com/grafana/writers-toolkit/blob/main/.github/workflows/publish-technical-documentation.yml.publish-technical-documentation-release.ymlhas been tested with https://github.com/grafana/backend-enterprise/blob/gem-release-2.13/.github/workflows/publish-technical-documentation-release.yml.Which issue(s) this PR fixes
Closes https://github.com/grafana/technical-documentation/issues/969
Notes to the Reviewer
There is some copy-paste involved in the creation of these workflows. Please check:
For
publish-technical-documentation-next.yml:on.pushbranchesandpathsfilters are correct for your repository.jobs.sync.ifrepository matches your repository.jobs.sync.steps[1].with.website_directorymatches the directory you publish to in the website repository.For
publish-technical-documentation-release.yml:on.pushbranches,tags, andpathsfilters are correct for your repository.jobs.sync.ifrepository matches your repository.jobs.sync.steps[1].with.release_tag_regexpregular expression matches your tags and captures major, minor, and patch versions from those tags.jobs.sync.steps[1].with.release_branch_regexpregular expression matches your release branch names and captures major and minor versions from those branch names.jobs.sync.steps[1].with.release_branch_with_patch_regexpregular expression matches your release branch names if they were to include a patch version, and that it would capture major, minor, and patch versions from those branch names.jobs.sync.steps[1].with.website_directorymatches the directory you publish to in the website repository.