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

[Feat] Automate smart contract docgen and PR branch creation into Linea docs repo #446

Merged
merged 18 commits into from
Dec 20, 2024
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions contracts/docs/scripts/create-docs-website-pr-branch.sh
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
### ASSUMPTIONS
# - Requires permissions to create a branch on docs.linea.build repo
# - Must execute this script from within linea-monorepo (can be anywhere)
# - Hardhat must be installed in the local project, forge must be installed globally
thedarkjester marked this conversation as resolved.
Show resolved Hide resolved
kyzooghost marked this conversation as resolved.
Show resolved Hide resolved

### CONSTANTS
DOCS_WEBSITE_REPO_NAME=doc.linea
Expand All @@ -30,6 +31,22 @@ MONOREPO_ROOT_PATH=$(git rev-parse --show-toplevel)
cd $MONOREPO_ROOT_PATH
cd contracts

# Check required installations
if ! command -v forge &> /dev/null; then
echo "Please install Foundry - https://book.getfoundry.sh/getting-started/installation"
exit 1
fi

if ! command -v pnpm &> /dev/null; then
echo "Please install pnpm - https://pnpm.io/installation"
exit 1
fi

if [ -z "$(pnpm -F contracts list hardhat)" ]; then
echo "Please install Hardhat - \`pnpm i\`"
exit 1
fi

# Docgen
npx hardhat docgen
kyzooghost marked this conversation as resolved.
Show resolved Hide resolved

Expand Down
Loading