-
Notifications
You must be signed in to change notification settings - Fork 32
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ci: build and push evm contract docs to github pages #211
base: main
Are you sure you want to change the base?
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #211 +/- ##
=======================================
Coverage 98.40% 98.40%
=======================================
Files 48 48
Lines 754 754
Branches 154 154
=======================================
Hits 742 742
Misses 3 3
Partials 9 9 ☔ View full report in Codecov by Sentry. |
branches: | ||
description: "Branches to trigger the workflow on" | ||
required: false | ||
default: "main,ci/evm-docs-to-github-pages" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TODO: remove PR branch
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll make this change once approved
.github/workflows/upload-docs.yaml
Outdated
runs-on: blacksmith-2vcpu-ubuntu-2204 | ||
steps: | ||
- name: Run Upload Docs Action | ||
uses: axelarnetwork/axelar-gmp-sdk-solidity/.github/actions/upload-docs@ci/evm-docs-to-github-pages |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TODO: change branch
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll make this change once approved
.github/workflows/upload-docs.yaml
Outdated
push: | ||
branches: | ||
- main | ||
- ci/evm-docs-to-github-pages |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TODO: remove this before merge
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM so long as the current comments are resolved and this PR's branch has been removed.
if ! npx hardhat docgen; then | ||
echo "Hardhat failed to generate documentation" | ||
exit 1 | ||
fi | ||
shell: bash | ||
|
||
- name: Check for generateOverviewDocs script |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Avoid this specialized logic. Just provide the script in this repo as input to this action as well
- name: Generate Overview Documentation if exists remotely | ||
if: steps.check-generate-overview-docs.outputs.exists == 'false' | ||
run: node ${{ inputs.script }} | ||
shell: bash |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- name: Generate Overview Documentation if exists remotely | |
if: steps.check-generate-overview-docs.outputs.exists == 'false' | |
run: node ${{ inputs.script }} | |
shell: bash | |
- name: Generate Overview Documentation if exists remotely | |
run: node ${{ inputs.script }} | |
shell: bash |
always do this
AXE-7083