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

Update workflows to use actions that don't need organization secrets #7009

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

jdbaldry
Copy link
Member

@jdbaldry jdbaldry commented Aug 28, 2024

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.

Notes to the Reviewer

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.

Closes https://github.com/grafana/technical-documentation/issues/968

@jdbaldry jdbaldry force-pushed the jdb/2024-08-update-publish-workflows-to-avoid-org-secrets branch from e7dc96d to 243280e Compare August 28, 2024 09:55
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 jdbaldry force-pushed the jdb/2024-08-update-publish-workflows-to-avoid-org-secrets branch from 243280e to 70eb2ee Compare August 28, 2024 09:58
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.

1 participant