There is some copy-paste involved in the creation of these workflows. Please check:
For publish-technical-documentation-next.yml:
[x] The on.pushbranches and paths filters are correct for your repository.
[x] The jobs.sync.if repository matches your repository.
[x] The jobs.sync.steps[1].with.website_directory matches the directory you publish to in the website repository.
For publish-technical-documentation-release.yml:
[x] The on.pushbranches, tags, and paths filters are correct for your repository.
[x] The jobs.sync.if repository matches your repository.
[x] The jobs.sync.steps[1].with.release_tag_regexp regular expression matches your tags and captures major, minor, and patch versions from those tags.
[x] 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.
[x] 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.
[x] 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.
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
:on.push
branches
andpaths
filters are correct for your repository.jobs.sync.if
repository matches your repository.jobs.sync.steps[1].with.website_directory
matches the directory you publish to in the website repository.For
publish-technical-documentation-release.yml
:on.push
branches
,tags
, andpaths
filters are correct for your repository.jobs.sync.if
repository matches your repository.jobs.sync.steps[1].with.release_tag_regexp
regular expression matches your tags and captures major, minor, and patch versions from those tags.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.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.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.
Fixes https://github.com/grafana/technical-documentation/issues/973