Skip to content
Generate Docs

update msig flow for secrets module #353

Sign in to view logs

update msig flow for secrets module

update msig flow for secrets module #353

Workflow file for this run

.github/workflows/generate-docs.yml at 71dbdc1
name: Generate Docs
on:
pull_request:
branches:
- main
- "releases/**"
jobs:
gendoc:
runs-on: ubuntu-latest
permissions:
id-token: write
contents: write
steps:
# Checkout the repository
- name: Checkout code
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # actions/[email protected]
# Set up Go environment
- name: Set up Go
uses: actions/setup-go@3041bf56c941b39c61721a86cd11f3bb1338122a # actions/[email protected]
- name: Setup GitHub Token
id: setup-github-token
uses: smartcontractkit/.github/actions/setup-github-token@ef78fa97bf3c77de6563db1175422703e9e6674f # [email protected]
with:
aws-role-arn: ${{ secrets.AWS_OIDC_DEV_PLATFORM_READ_REPOS_EXTERNAL_TOKEN_ISSUER_ROLE_ARN }}
aws-lambda-url: ${{ secrets.AWS_DEV_SERVICES_TOKEN_ISSUER_LAMBDA_URL }}
aws-region: ${{ secrets.AWS_REGION }}
aws-role-duration-seconds: "1800" # this is optional and defaults to 900
set-git-config: true
# Temporarily remove everything in the docs folder to easily detect all diffs, including command removals
- name: Clean up docs folder
run: rm -f docs/*
# Regenerate the documentation
- name: Generate docs
env:
GITHUB_TOKEN: ${{ steps.setup-github-token.outputs.access-token }}
#TODO (DEVSVCS-2016) clean the GOLANG_PROTOBUF_REGISTRATION_CONFLICT flag
run: GOLANG_PROTOBUF_REGISTRATION_CONFLICT=warn go run gendoc/main.go
# Compare if generated docs are different from the docs on this git branch
- name: Compare generated docs
run: |
git diff --stat --exit-code ./docs || {
echo "Please generate docs locally and commit the changes.";
echo "To achieve this, you can run the following command:";
echo "make gendoc";
exit 1;
}