From f80d035030669df6c34447267978f011a246917a Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 6 Nov 2023 10:09:09 +0000 Subject: [PATCH] Update `make docs` procedure (#3265) [Use versioned action to update make-docs procedure](https://github.com/grafana/oncall/pull/3265/commits/d9c09cce5841f4d10a0e14f4439b6d264721a538) [d9c09cc](https://github.com/grafana/oncall/pull/3265/commits/d9c09cce5841f4d10a0e14f4439b6d264721a538) https://github.com/grafana/writers-toolkit/blob/main/update-make-docs/action.yml --------- Signed-off-by: Jack Baldry Co-authored-by: grafanabot Co-authored-by: Jack Baldry --- .github/workflows/update-make-docs.yml | 23 +++++------------------ docs/make-docs | 2 +- 2 files changed, 6 insertions(+), 19 deletions(-) diff --git a/.github/workflows/update-make-docs.yml b/.github/workflows/update-make-docs.yml index 4d4ce6a5..cda2f5fd 100644 --- a/.github/workflows/update-make-docs.yml +++ b/.github/workflows/update-make-docs.yml @@ -2,26 +2,13 @@ name: Update `make docs` procedure "on": schedule: - cron: "0 7 * * 1-5" + workflow_dispatch: jobs: main: if: github.repository == 'grafana/oncall' runs-on: ubuntu-latest steps: - - name: Checkout repository - uses: actions/checkout@v3 - - - name: Update procedure - run: | - BRANCH=update-make-docs - git checkout -b "${BRANCH}" - curl -s -Lo docs/docs.mk https://raw.githubusercontent.com/grafana/writers-toolkit/main/docs/docs.mk - curl -s -Lo docs/make-docs https://raw.githubusercontent.com/grafana/writers-toolkit/main/docs/make-docs - if git diff --exit-code; then exit 0; fi - git add . - git config --local user.email "bot@grafana.com" - git config --local user.name "grafanabot" - git commit -m "Update \`make docs\` procedure" - git push -v origin "refs/heads/${BRANCH}" - gh pr create --fill --label "pr:no changelog" || true - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + - uses: actions/checkout@v4 + - uses: grafana/writers-toolkit/update-make-docs@update-make-docs/v1 + with: + pr_options: --label "pr:no changelog" diff --git a/docs/make-docs b/docs/make-docs index badc36a4..751e22f4 100755 --- a/docs/make-docs +++ b/docs/make-docs @@ -38,7 +38,7 @@ # # - Imperfect implementation of container name. # -# Faciliates running `make vale` and `make docs` at once. +# Facilitates running `make vale` and `make docs` at once. # Container names are convenient for recognition in `docker ps` but the current implementation has more downsides than upsides. # # - Forced platform specification now that multiple architecture images exist.