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.

Sign up for GitHub

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

Jump to bottom

2503 doc autogen #2539

Closed
wants to merge 33 commits into from
Closed

2503 doc autogen #2539

wants to merge 33 commits into from

Conversation

owenwahlgren
Copy link
Collaborator

Why this should be merged

Autogenerate markdown for CLI cmds that can be remotely fetched

How this works

Github action on PR to main with python script that generates markdown

@owenwahlgren owenwahlgren requested a review from a team as a code owner January 8, 2025 22:46
@owenwahlgren owenwahlgren linked an issue Jan 8, 2025 that may be closed by this pull request
Doc Autogen #2503
Open
@owenwahlgren owenwahlgren added the DO NOT MERGE This PR is not meant to be merged in its current state label Jan 8, 2025
@owenwahlgren owenwahlgren removed the DO NOT MERGE This PR is not meant to be merged in its current state label Jan 8, 2025
@meaghanfitzgerald
Copy link
Collaborator

What is the output path of the doc? The generated doc will then be referenced in docs at: https://docs.avax.network/tooling/avalanche-cli , right?

@owenwahlgren
Copy link
Collaborator Author

What is the output path of the doc? The generated doc will then be referenced in docs at: https://docs.avax.network/tooling/avalanche-cli , right?

output of the .md file is in root of this project /
This will be remote referenced at https://docs.avax.network/tooling/avalanche-cli yes

@meaghanfitzgerald
Copy link
Collaborator

output of the .md file is in root of this project /

please output the file in the cmd folder, named commands.md

Ideally we will also autogen the SDK docs which would ideally live in sdk folder.

meaghanfitzgerald
meaghanfitzgerald reviewed Jan 13, 2025
View reviewed changes
cmd/commands.md Outdated
Comment on lines 152 to 157
-l, --local operate on a local network
-m, --mainnet operate on mainnet
--node-endpoint string gather node id/bls from publicly available avalanchego apis on the given endpoint
--node-id string node-id of the validator to add
--output-tx-path string (for Subnets, not L1s) file path of the add validator tx
--partial-sync set primary network partial sync for new validators (default true)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Some of the flags are being generated without a type, causing the description to split (see original line 152)

Suggested change
-l, --local operate on a local network
-m, --mainnet operate on mainnet
--node-endpoint string gather node id/bls from publicly available avalanchego apis on the given endpoint
--node-id string node-id of the validator to add
--output-tx-path string (for Subnets, not L1s) file path of the add validator tx
--partial-sync set primary network partial sync for new validators (default true)
-l, --local none operate on a local network
-m, --mainnet none operate on mainnet
--node-endpoint string gather node id/bls from publicly available avalanchego apis on the given endpoint
--node-id string node-id of the validator to add
--output-tx-path string (for Subnets, not L1s) file path of the add validator tx
--partial-sync none set primary network partial sync for new validators (default true)

Copy link
Collaborator

Choose a reason for hiding this comment

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

Is this due to the script or the CLI command code? This happens consistently throughout the generated commands doc

@meaghanfitzgerald meaghanfitzgerald added this to the Documentation milestone Jan 13, 2025
@meaghanfitzgerald
Copy link
Collaborator

closes #2503

dependabot bot and others added 6 commits January 23, 2025 11:45
@dependabot @arturrez @owenwahlgren
Bump google.golang.org/api from 0.214.0 to 0.215.0 (#2529)
ec37e5f 
Bumps [google.golang.org/api](https://github.com/googleapis/google-api-go-client) from 0.214.0 to 0.215.0.
- [Release notes](https://github.com/googleapis/google-api-go-client/releases)
- [Changelog](https://github.com/googleapis/google-api-go-client/blob/main/CHANGES.md)
- [Commits](googleapis/google-api-go-client@v0.214.0...v0.215.0)

---
updated-dependencies:
- dependency-name: google.golang.org/api
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: arturrez <[email protected]>
@dependabot @owenwahlgren
Bump google.golang.org/protobuf from 1.36.1 to 1.36.2 (#2540)
d701f9c 
Bumps google.golang.org/protobuf from 1.36.1 to 1.36.2.

---
updated-dependencies:
- dependency-name: google.golang.org/protobuf
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@owenwahlgren
update output path
9491aa9
@owenwahlgren
format fix
7d8407c
@owenwahlgren
chore: Update MD file [skip ci]
ec20dbf
@felipemadero @owenwahlgren
improve evm proposer vm activation error handling (#2534)
dae01ed 
* improve evm proposer vm activation error handling

* address PR comment
felipemadero and others added 16 commits January 23, 2025 11:45
@felipemadero @arturrez @owenwahlgren
support contract owners for custom subnet evm binary (#2536)
5f9c834 
* support contract owners for custom subnet evm binary

* address PR comment

---------

Co-authored-by: arturrez <[email protected]>
@dependabot @arturrez @owenwahlgren
Bump github.com/aws/aws-sdk-go-v2 from 1.32.7 to 1.32.8 (#2546)
54a0dca 
Bumps [github.com/aws/aws-sdk-go-v2](https://github.com/aws/aws-sdk-go-v2) from 1.32.7 to 1.32.8.
- [Release notes](https://github.com/aws/aws-sdk-go-v2/releases)
- [Changelog](https://github.com/aws/aws-sdk-go-v2/blob/main/changelog-template.json)
- [Commits](aws/aws-sdk-go-v2@v1.32.7...v1.32.8)

---
updated-dependencies:
- dependency-name: github.com/aws/aws-sdk-go-v2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: arturrez <[email protected]>
@dependabot @arturrez @owenwahlgren
Bump github.com/spf13/afero from 1.11.0 to 1.12.0 (#2547)
ea23a45 
Bumps [github.com/spf13/afero](https://github.com/spf13/afero) from 1.11.0 to 1.12.0.
- [Release notes](https://github.com/spf13/afero/releases)
- [Commits](spf13/afero@v1.11.0...v1.12.0)

---
updated-dependencies:
- dependency-name: github.com/spf13/afero
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: arturrez <[email protected]>
@owenwahlgren
chore: Update MD file [skip ci]
7da695c
@owenwahlgren
test
aea1c99
@owenwahlgren
fix: commit action
6be6b7b
@dependabot @owenwahlgren
Bump google.golang.org/api from 0.215.0 to 0.216.0 (#2550)
d0c3936 
Bumps [google.golang.org/api](https://github.com/googleapis/google-api-go-client) from 0.215.0 to 0.216.0.
- [Release notes](https://github.com/googleapis/google-api-go-client/releases)
- [Changelog](https://github.com/googleapis/google-api-go-client/blob/main/CHANGES.md)
- [Commits](googleapis/google-api-go-client@v0.215.0...v0.216.0)

---
updated-dependencies:
- dependency-name: google.golang.org/api
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot @arturrez @owenwahlgren
Bump github.com/aws/aws-sdk-go-v2/config from 1.28.7 to 1.28.10 (#2551)
3122675 
Bumps [github.com/aws/aws-sdk-go-v2/config](https://github.com/aws/aws-sdk-go-v2) from 1.28.7 to 1.28.10.
- [Release notes](https://github.com/aws/aws-sdk-go-v2/releases)
- [Changelog](https://github.com/aws/aws-sdk-go-v2/blob/main/changelog-template.json)
- [Commits](aws/aws-sdk-go-v2@config/v1.28.7...config/v1.28.10)

---
updated-dependencies:
- dependency-name: github.com/aws/aws-sdk-go-v2/config
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: arturrez <[email protected]>
@felipemadero @owenwahlgren
Improve change weight (#2545)
9428410 
* improve change weight

* partial work

* implemented!

* move functions to SDK

* nit

* make all balances float

* use sdk network object on sdk functions

* reduce dep on pkg from sdk helper

* address PR comment

* mv functions to validator SDK package

* address PR comments
@dashangcun @arturrez
@felipemadero @owenwahlgren
refactor: using slices.Contains to simplify the code (#2552)
de11ecc 
Signed-off-by: dashangcun <[email protected]>
Co-authored-by: arturrez <[email protected]>
Co-authored-by: felipemadero <[email protected]>
@owenwahlgren
chore: Update MD file [skip ci]
54813cd
@sukantoraymond @owenwahlgren
Use local machine to join as validator on any L1 (#2548)
a6c81b8 
* use local machine to join as validator

* fix lint

* update validate function

* local machine validate l1

* update command description

* lint

* lint

* address comments

* fix merge

* address comments

* enable more than 1 node in a cluster to validate

* address comments

* fix lint

* fix lint

---------

Signed-off-by: sukantoraymond <[email protected]>
@dependabot @owenwahlgren
Bump github.com/aws/aws-sdk-go-v2/service/ec2 from 1.198.1 to 1.200.0 (…
2fd91b1 
…#2564)

Bumps [github.com/aws/aws-sdk-go-v2/service/ec2](https://github.com/aws/aws-sdk-go-v2) from 1.198.1 to 1.200.0.
- [Release notes](https://github.com/aws/aws-sdk-go-v2/releases)
- [Changelog](https://github.com/aws/aws-sdk-go-v2/blob/main/changelog-template.json)
- [Commits](aws/aws-sdk-go-v2@service/ec2/v1.198.1...service/ec2/v1.200.0)

---
updated-dependencies:
- dependency-name: github.com/aws/aws-sdk-go-v2/service/ec2
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot @owenwahlgren
Bump github.com/docker/docker (#2554)
6454a79 
Bumps [github.com/docker/docker](https://github.com/docker/docker) from 27.4.1+incompatible to 27.5.0+incompatible.
- [Release notes](https://github.com/docker/docker/releases)
- [Commits](moby/moby@v27.4.1...v27.5.0)

---
updated-dependencies:
- dependency-name: github.com/docker/docker
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@owenwahlgren
chore: Update MD file [skip ci]
595cfa4
@owenwahlgren
try another way
179a819
@owenwahlgren owenwahlgren mentioned this pull request Jan 23, 2025
Open
@owenwahlgren
Copy link
Collaborator Author

closing in favor of #2570

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@meaghanfitzgerald meaghanfitzgerald meaghanfitzgerald approved these changes

@sukantoraymond sukantoraymond Awaiting requested review from sukantoraymond sukantoraymond is a code owner automatically assigned from ava-labs/tooling

@arturrez arturrez Awaiting requested review from arturrez arturrez is a code owner automatically assigned from ava-labs/tooling

Assignees
No one assigned
Labels
None yet
Projects
Platform Engineering Group
Status: Done ✅
Milestone
Documentation
Development

Successfully merging this pull request may close these issues.

Doc Autogen
5 participants
@owenwahlgren @meaghanfitzgerald @felipemadero @dashangcun @sukantoraymond