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 #1553

Merged
merged 1 commit into from
Jan 22, 2025

Conversation

jdbaldry
Copy link
Member

@jdbaldry jdbaldry commented Jan 21, 2025

Until this is merged, no documentation can be published from this repository to the website.

Each repository can only have 100 organization secrets and there are now more than 100 in our organization which causes inconsistent 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. 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.

We'll also need to backport this to any branches where you are maintaining documentation that you want synced to the website.

Each repository can only have 100 organization secrets and there are now more than 100 in our organization which causes inconsistent 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.
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.

We'll also need to backport this to any branches where you are maintaining documentation that you want synced to the website.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry jdbaldry requested a review from a team as a code owner January 21, 2025 11:12
Copy link

codecov bot commented Jan 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.12%. Comparing base (9743007) to head (ac69c56).
Report is 7 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1553      +/-   ##
==========================================
- Coverage   71.21%   71.12%   -0.10%     
==========================================
  Files         197      197              
  Lines       19664    19664              
==========================================
- Hits        14004    13986      -18     
- Misses       4986     4998      +12     
- Partials      674      680       +6     
Flag Coverage Δ
integration-test 53.07% <ø> (-0.08%) ⬇️
k8s-integration-test 52.66% <ø> (-0.73%) ⬇️
oats-test 32.72% <ø> (+0.13%) ⬆️
unittests 47.32% <ø> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jdbaldry jdbaldry merged commit 7df606f into main Jan 22, 2025
13 checks passed
@jdbaldry jdbaldry deleted the jdb/2025-use-vault-secrets branch January 22, 2025 13:56
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.

2 participants