Skip to content

Commit

Permalink
Merge pull request #313 from GoogleCloudPlatform/issue312
Browse files Browse the repository at this point in the history
chore: automate docs publish #312
  • Loading branch information
srinandan authored Dec 6, 2024
2 parents e865f82 + a82cc64 commit 82435d9
Showing 1 changed file with 24 additions and 14 deletions.
38 changes: 24 additions & 14 deletions .github/workflows/gen-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,43 +14,53 @@

# Generate documentation for integrationcli
name: integrationcli 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 integrationcli Documentation
runs-on: ubuntu-latest
permissions:
contents: write # needed to create PR
packages: write
id-token: write
attestations: write
pull-requests: write
repository-projects: write

steps:
- name: Checkout Code
uses: actions/checkout@1e31de5234b9f8995739874a8ce0492dc87873e2 #v4
- uses: actions/setup-go@0c52d547c9bc32b1aa3301fd7a9cb496313a4491 #v5
with:
go-version-file: './go.mod'
check-latest: true
- name: Push GH Pages
env:
GH_TOKEN: ${{ secrets.TOKEN }}
run: |
SHORT_SHA=$(git rev-parse --short $GITHUB_SHA)
git config pull.rebase false
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 fetch origin main
git fetch origin gh_pages
git checkout gh_pages
git merge origin/main --allow-unrelated-histories
GOBIN=/tmp/ go install github.com/google/[email protected]
/tmp/go-licenses csv ./cmd/integrationcli > third-party-licenses.txt || echo "Ignore warnings"
/tmp/go-licenses save ./cmd/integrationcli --save_path=third-party --force || echo "Ignore warnings"
git add third-party third-party-licenses.txt
git commit -m "generate licenses - $GITHUB_SHA" || echo "No Changes in license"
git commit -m "generate licenses - $SHORT_SHA" || echo "No Changes in license"
go run docs/docs.go
git add --all
git commit -m "Update GH Pages - $GITHUB_SHA" || echo "No Changes in docs"
git push origin docs_$SHORT_SHA
git commit -m "Update GH Pages - $SHORT_SHA" || echo "No Changes in docs"
git push origin gh_pages
gh pr create --title "Update Documentation" --body "update docs to ${GITHUB_SHA}" --base main --head gh_pages

0 comments on commit 82435d9

Please sign in to comment.