Skip to content

Commit

Permalink
GitHub Pages V2 Docs (#440)
Browse files Browse the repository at this point in the history
* Serve the V2 API docs as static GitHub Pages assets, deployed via GitHub Actions
* moved over from [CCNG PR #3874](cloudfoundry/cloud_controller_ng#3874)
to avoid collision with v3 docs already bound to that repo
  • Loading branch information
pivotalgeorge authored Jul 12, 2024
1 parent 18d2d9a commit 7bfe0c1
Showing 1 changed file with 62 additions and 0 deletions.
62 changes: 62 additions & 0 deletions .github/workflows/gh_pages_docs_v2.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: Deploy V2 Docs to GitHub Pages

on:
push:
branches:
- main
# Allow manual workflow run
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
push-v2:
runs-on: ubuntu-latest
steps:
- name: Checkout this repo
uses: actions/checkout@v4
with:
path: capi-release
- name: Checkout CCNG
uses: actions/checkout@v4
with:
repository: cloudfoundry/cloud_controller_ng
path: cloud_controller_ng
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Render index template
working-directory: cloud_controller_ng/docs/v2
run: |
pwd
ls
./render.sh
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: cloud_controller_ng/docs/v2

# Deployment job
deploy:
runs-on: ubuntu-latest
needs: push-v2
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
defaults:
run:
working-directory: ./docs/v3
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

0 comments on commit 7bfe0c1

Please sign in to comment.