-
Notifications
You must be signed in to change notification settings - Fork 296
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update publishing workflows to use GitHub App authentication (#5399)
# What this PR does Use a centralized composite action that uses GitHub App authentication to publish documentation. The organization secrets used in the current workflows have expired. ## Checklist - [ ] Unit, integration, and e2e (if applicable) tests updated - [x] Documentation added (or `pr:no public docs` PR label added if not required) - [x] Added the relevant release notes label (see labels prefixed w/ `release:`). These labels dictate how your PR will show up in the autogenerated release notes. Signed-off-by: Jack Baldry <[email protected]>
- Loading branch information
Showing
2 changed files
with
22 additions
and
124 deletions.
There are no files selected for viewing
57 changes: 10 additions & 47 deletions
57
.github/workflows/publish-technical-documentation-next.yml
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,58 +1,21 @@ | ||
name: "Publish Technical Documentation (next)" | ||
name: publish-technical-documentation-next | ||
|
||
on: | ||
push: | ||
branches: | ||
- "main" | ||
- main | ||
paths: | ||
- "docs/sources/**" | ||
workflow_dispatch: | ||
|
||
jobs: | ||
test: | ||
runs-on: "ubuntu-latest" | ||
steps: | ||
- name: "Check out code" | ||
uses: "actions/checkout@v4" | ||
- name: "Build website" | ||
# -e HUGO_REFLINKSERRORLEVEL=ERROR prevents merging broken refs with the downside | ||
# that no refs to external content can be used as these refs will not resolve in the | ||
# docs-base image. | ||
run: > | ||
docker run -v ${PWD}/docs/sources:/hugo/content/docs/oncall/latest | ||
-e HUGO_REFLINKSERRORLEVEL=ERROR | ||
--rm grafana/docs-base:latest /bin/bash | ||
-c 'echo -e "---\\nredirectURL: /hugo/content/docs/oncall/latest/\\ntype: redirect\\nversioned: true\\n---\\n" | ||
> /hugo/content/docs/oncall/_index.md; make hugo' | ||
sync: | ||
runs-on: "ubuntu-latest" | ||
needs: "test" | ||
if: github.repository == 'grafana/oncall' | ||
permissions: | ||
contents: read | ||
id-token: write | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: "Check out code" | ||
uses: "actions/checkout@v4" | ||
|
||
- name: "Clone website-sync Action" | ||
# WEBSITE_SYNC_TOKEN is a fine-grained GitHub Personal Access Token that expires. | ||
# It must be regenerated in the grafanabot GitHub account and requires a Grafana organization | ||
# GitHub administrator to update the organization secret. | ||
# The IT helpdesk can update the organization secret. | ||
run: | | ||
git clone --single-branch --no-tags --depth 1 \ | ||
-b master https://grafanabot:${{ secrets.WEBSITE_SYNC_TOKEN }}@github.com/grafana/website-sync \ | ||
./.github/actions/website-sync | ||
- name: "Publish to website repository (next)" | ||
uses: "./.github/actions/website-sync" | ||
id: "publish-next" | ||
- uses: actions/checkout@v4 | ||
- uses: grafana/writers-toolkit/publish-technical-documentation@publish-technical-documentation/v1 | ||
with: | ||
repository: "grafana/website" | ||
branch: "master" | ||
host: "github.com" | ||
# PUBLISH_TO_WEBSITE_TOKEN is a fine-grained GitHub Personal Access Token that expires. | ||
# It must be regenerated in the grafanabot GitHub account and requires a Grafana organization | ||
# GitHub administrator to update the organization secret. | ||
# The IT helpdesk can update the organization secret. | ||
github_pat: "grafanabot:${{ secrets.PUBLISH_TO_WEBSITE_TOKEN }}" | ||
source_folder: "docs/sources" | ||
target_folder: "content/docs/oncall/next" | ||
website_directory: content/docs/oncall/next |
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