-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Adin Ermie
committed
Dec 2, 2024
1 parent
80de8cb
commit e2474be
Showing
2 changed files
with
37 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
name: TechDocs Pull Request Checks | ||
|
||
on: | ||
pull_request: | ||
paths: | ||
- "mkdocs.yml" | ||
- "docs/*" | ||
|
||
jobs: | ||
techdocs_pr_job: | ||
runs-on: ubuntu-latest | ||
|
||
name: Build and Check TechDocs | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
with: | ||
fetch-depth: 0 | ||
|
||
- name: Build TechDocs | ||
uses: bcgov/devhub-techdocs-publish@stable | ||
id: build_only | ||
with: | ||
strict_validation: 'true' | ||
publish: 'false' | ||
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 }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
CheckLinks: false # don't check URLs in <link> elements | ||
IgnoreDirectoryMissingTrailingSlash: true # don't fail when directory links don't have a trailing slash - techdocs generates a lot of valid links that would cause this check to fail | ||
IgnoreURLs: | ||
- "localhost" # suppress failures of URLs containing localhost | ||
- "https://github.com/bcgov-c" | ||
- "https://login.nimbus.cloud.gov.bc.ca/" |