Skip to content

Commit

Permalink
Merge pull request #14 from bcgov/add-pipeline
Browse files Browse the repository at this point in the history
added dev pipeline
  • Loading branch information
MaxWardle authored Dec 11, 2023
2 parents 720323b + 8284304 commit db749e3
Show file tree
Hide file tree
Showing 3 changed files with 67 additions and 3 deletions.
29 changes: 29 additions & 0 deletions .github/workflows/publish-dev.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Build TechDocs with DevHub TechDocs Publish Action

on:
workflow_dispatch:
push:
branches: [ dev ]
paths:
- "mkdocs.yml"
- "docs/*"

jobs:
test_techdocs_build_job:
runs-on: ubuntu-latest

name: A job to build and publish techdocs content
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Build TechDocs
uses: bcgov/devhub-techdocs-publish@stable
id: build_and_publish
with:
publish: 'true'
production: 'false'
bucket_name: ${{ secrets.TECHDOCS_S3_BUCKET_NAME }}
s3_access_key_id: ${{ secrets.TECHDOCS_AWS_ACCESS_KEY_ID }}
s3_secret_access_key: ${{ secrets.TECHDOCS_AWS_SECRET_ACCESS_KEY }}
s3_region: ${{ secrets.TECHDOCS_AWS_REGION }}
s3_endpoint: ${{ secrets.TECHDOCS_AWS_ENDPOINT }}
30 changes: 30 additions & 0 deletions .github/workflows/publish-prod.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# name: Build TechDocs with DevHub TechDocs Publish Action

# on:
# workflow_dispatch:
# push:
# branches: [ main ]
# paths:
# - "mkdocs.yml"
# - "docs/*"

# jobs:
# test_techdocs_build_job:
# runs-on: ubuntu-latest

# name: A job to build and publish techdocs content
# steps:
# - name: Checkout
# uses: actions/checkout@v4
# - name: Build TechDocs
# uses: bcgov/devhub-techdocs-publish@stable
# id: build_and_publish
# with:
# publish: 'true'
# production: 'true'
# # production: ${{ github.ref == 'refs/heads/main' && 'true' || 'false' }} # example of only pushing to prod DevHub when changes that triggered the job are in `main` branch
# bucket_name: ${{ secrets.TECHDOCS_S3_BUCKET_NAME }}
# s3_access_key_id: ${{ secrets.TECHDOCS_AWS_ACCESS_KEY_ID }}
# s3_secret_access_key: ${{ secrets.TECHDOCS_AWS_SECRET_ACCESS_KEY }}
# s3_region: ${{ secrets.TECHDOCS_AWS_REGION }}
# s3_endpoint: ${{ secrets.TECHDOCS_AWS_ENDPOINT }}
11 changes: 8 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
site_name: BC Government Public Cloud Technical Documentation
docs_dir: docs
# nav:
# - General:
# - Some Menu Item: docs/design-system/about-the-design-system.md
nav:
- Get Started:
- B.C. Government AWS Landing Zone overview: bc-govs-aws-landing-zone-overview.md
- Provision a project set in AWS: provision-a-project-set.md
- Account access: provision-a-project-set.md#account-access
- Design, Build and Deploy an Application:
- Deploy an app to BC Gov's AWS Landing Zone: deploy-an-app-to-the-aws-landing-zone
- AWS IAM User service: iam-user-service.md
plugins:
- techdocs-core

0 comments on commit db749e3

Please sign in to comment.