Skip to content
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

Open
wants to merge 48 commits into
base: main
Choose a base branch
from

Conversation

TanvirDeol
Copy link

@TanvirDeol TanvirDeol commented Jan 31, 2025

Copy link

codecov bot commented Jan 31, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.40%. Comparing base (432449d) to head (b0e8b88).

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.
📢 Have feedback on the report? Share it here.

@TanvirDeol TanvirDeol marked this pull request as ready for review February 1, 2025 00:08
@TanvirDeol TanvirDeol requested a review from a team as a code owner February 1, 2025 00:08
.github/actions/upload-docs/action.yaml Outdated Show resolved Hide resolved
branches:
description: "Branches to trigger the workflow on"
required: false
default: "main,ci/evm-docs-to-github-pages"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: remove PR branch

Copy link
Author

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/actions/upload-docs/action.yaml Outdated Show resolved Hide resolved
.github/actions/upload-docs/action.yaml Outdated Show resolved Hide resolved
scripts/generateOverviewDocs.js Outdated Show resolved Hide resolved
scripts/generateOverviewDocs.js Outdated Show resolved Hide resolved
scripts/generateOverviewDocs.js Show resolved Hide resolved
scripts/generateOverviewDocs.js Outdated Show resolved Hide resolved
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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: change branch

Copy link
Author

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

scripts/generateOverviewDocs.js Show resolved Hide resolved
.github/actions/upload-docs/action.yaml Outdated Show resolved Hide resolved
.github/actions/upload-docs/action.yaml Outdated Show resolved Hide resolved
.github/actions/upload-docs/action.yaml Outdated Show resolved Hide resolved
.github/actions/upload-docs/action.yaml Show resolved Hide resolved
.github/actions/upload-docs/action.yaml Outdated Show resolved Hide resolved
.github/actions/upload-docs/action.yaml Outdated Show resolved Hide resolved
.github/workflows/upload-docs.yaml Outdated Show resolved Hide resolved
.github/actions/upload-docs/action.yaml Show resolved Hide resolved
.github/actions/upload-docs/action.yaml Show resolved Hide resolved
.github/actions/upload-docs/action.yaml Outdated Show resolved Hide resolved
.github/actions/upload-docs/action.yaml Outdated Show resolved Hide resolved
.github/actions/upload-docs/action.yaml Show resolved Hide resolved
push:
branches:
- main
- ci/evm-docs-to-github-pages
Copy link
Member

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

.github/workflows/upload-docs.yaml Outdated Show resolved Hide resolved
contracts/governance/BaseWeightedMultisig.sol Show resolved Hide resolved
hardhat.config.js Show resolved Hide resolved
scripts/generateOverviewDocs.js Outdated Show resolved Hide resolved
scripts/generateOverviewDocs.js Outdated Show resolved Hide resolved
Copy link

@nbayindirli nbayindirli left a 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.

.github/actions/upload-docs/action.yaml Show resolved Hide resolved
contracts/governance/BaseWeightedMultisig.sol Show resolved Hide resolved
hardhat.config.js Show resolved Hide resolved
.github/actions/upload-docs/action.yaml Show resolved Hide resolved
.github/actions/upload-docs/action.yaml Show resolved Hide resolved
if ! npx hardhat docgen; then
echo "Hardhat failed to generate documentation"
exit 1
fi
shell: bash

- name: Check for generateOverviewDocs script
Copy link
Member

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

Comment on lines +53 to +56
- name: Generate Overview Documentation if exists remotely
if: steps.check-generate-overview-docs.outputs.exists == 'false'
run: node ${{ inputs.script }}
shell: bash
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants