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

Update markdown md CI #2585

Closed
wants to merge 8 commits into from
Closed
Show file tree
Hide file tree
Changes from all 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
32 changes: 14 additions & 18 deletions .github/workflows/update-markdown.yml
Original file line number Diff line number Diff line change
@@ -1,19 +1,15 @@
name: Update Markdown

on:
push:
branches:
- main
pull_request:
branches:
- main
types: [approved] # Runs only when the PR is approved

jobs:
update-md:
runs-on: ubuntu-latest

steps:
- name: Check out the repo
- name: Check out the repo on the PR branch
uses: actions/checkout@v3
with:
ref: ${{ github.head_ref }}
Expand All @@ -40,7 +36,7 @@ jobs:
- name: Install dependencies
run: |
pip install --upgrade pip
# If you need additional dependencies, install them here
# Add any other dependencies if required
# pip install -r requirements.txt

- name: Generate CLI MD
Expand All @@ -53,14 +49,14 @@ jobs:
run: |
python .github/scripts/sdk_doc.py

- name: Commit files
uses: ChromeQ/[email protected]
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
files: |
cmd/commands.md
sdk/SDK.md
commit-message: "chore: Update MD files [skip ci]"
ref: ${{ github.head_ref }}

- name: Commit and push changes to the PR branch
run: |
git config --global user.name "github-actions[bot]"
git config --global user.email "github-actions[bot]@users.noreply.github.com"
git checkout ${{ github.head_ref }} # Ensure we're on the PR branch

git add cmd/commands.md sdk/SDK.md
git commit -m "chore: Update MD files" || echo "No changes to commit"

git push origin ${{ github.head_ref }}
2 changes: 1 addition & 1 deletion cmd/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ avalanche blockchain create [subcommand] [flags]
--evm-token string token symbol to use with Subnet-EVM
--external-gas-token use a gas token from another blockchain
-f, --force overwrite the existing configuration if one exists
--from-github-repo generate custom VM binary from github repository
--from-github-repos generate custom VM binary from github repository
Copy link
Collaborator

Choose a reason for hiding this comment

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

why this change?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

its test change to see if it will be removed before this pr is merged by the CI

--genesis string file path of genesis to use
-h, --help help for create
--icm interoperate with other blockchains using ICM
Expand Down
Loading