Skip to content

Commit

Permalink
feat: automate publishing docs (#593)
Browse files Browse the repository at this point in the history
* feat: automate publishing docs

* update branch name
  • Loading branch information
srinandan authored Dec 4, 2024
1 parent d764e6a commit 5dd8f11
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions .github/workflows/gen-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,22 @@

# Generate documentation for apigeecli
name: apigeecli Github Pages Pipeline

permissions: read-all
on:
#push:
# Publish semver tags as releases.
# tags:
# - v[0-9].[0-9]+.[0-9]
push:
# Publish semver tags as releases.
tags:
- v[0-9].[0-9]+.[0-9]
workflow_dispatch:

jobs:
publish-gh-pages:
name: Publish apigeecli Documentation
runs-on: ubuntu-latest
permissions:
contents: write # needed to create PR
packages: write

steps:
- name: Checkout Code
uses: actions/checkout@1e31de5234b9f8995739874a8ce0492dc87873e2 #v4
Expand All @@ -36,8 +40,8 @@ jobs:
git config --global user.name "$(git log -n 1 --pretty=format:%an)"
git config --global user.email "$(git log -n 1 --pretty=format:%ae)"
git pull origin main --allow-unrelated-histories
git checkout -b docs_$SHORT_SHA
git checkout gh_pages
git reset --hard origin/main
GOBIN=/tmp/ go install github.com/google/go-licenses@v1.0.0
/tmp/go-licenses csv ./cmd/apigeecli > third-party-licenses.txt || echo "Ignore warnings"
Expand All @@ -50,4 +54,5 @@ jobs:
git add --all
git commit -m "Update GH Pages - $SHORT_SHA" || echo "No Changes in docs"
git push origin docs_$SHORT_SHA
git push origin gh_pages
gh pr create --title "Update Documentation" --body "update docs to ${GITHUB_SHA}" --base main --head docs

0 comments on commit 5dd8f11

Please sign in to comment.