Adding scripts & documentation for the SC calls executor #412
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
iulianpascalau
commented
Jan 17, 2025
•
iulianpascalau
commented
- added scripts for the SC calls executor
- added documentation for the SC calls executor
- fixed the flag for providing sc proxy addresses
- added CLI.md file & the generating script
…into scripts-docs-sc-calls-executor
- fixed the flag for providing sc proxy addresses - added CLI.md file & the generating script
iulianpascalau
changed the title
sanechekmyflow
approved these changes
Jan 21, 2025
valentin-lup
previously approved these changes
Jan 22, 2025
Makefile
Outdated
| echo "Error - please update all CLI.md files by running the 'cli-docs' or 'check-cli-md' from Makefile!"; \ | ||
| exit 1; \ | ||
| fi |
Makefile
Outdated
Comment on lines
42
to
43
| cd ./cmd && bash ./CLI.md.sh |
There was a problem hiding this comment.
can be reused cli-docs
cmd/scCallsExecutor/CLI.md
Outdated
|
|
||
| GLOBAL OPTIONS: | ||
| --working-directory directory This flag specifies the directory where the node will store databases and logs. | ||
| --log-level level(s) This flag specifies the logger level(s). It can contain multiple comma-separated value. For example, if set to *:INFO the logs for all packages will have the INFO level. However, if set to *:INFO,api:DEBUG the logs for all packages will have the INFO level, excepting the api package which will receive a DEBUG log level. (default: "*:DEBUG") |
There was a problem hiding this comment.
Suggested change
| --log-level level(s) This flag specifies the logger level(s). It can contain multiple comma-separated value. For example, if set to *:INFO the logs for all packages will have the INFO level. However, if set to *:INFO,api:DEBUG the logs for all packages will have the INFO level, excepting the api package which will receive a DEBUG log level. (default: "*:DEBUG") | |
| --log-level level(s) This flag specifies the logger level(s). It can contain multiple comma-separated values. For example, if set to *:INFO the logs for all packages will have the INFO level. However, if set to *:INFO,api:DEBUG the logs for all packages will have the INFO level, excepting the api package which will receive a DEBUG log level. (default: "*:DEBUG") |
cmd/scCallsExecutor/CLI.md
Outdated
| --working-directory directory This flag specifies the directory where the node will store databases and logs. | ||
| --log-level level(s) This flag specifies the logger level(s). It can contain multiple comma-separated value. For example, if set to *:INFO the logs for all packages will have the INFO level. However, if set to *:INFO,api:DEBUG the logs for all packages will have the INFO level, excepting the api package which will receive a DEBUG log level. (default: "*:DEBUG") | ||
| --disable-ansi-color Boolean option for disabling ANSI colors in the logging system. | ||
| --config [path] The [path] for the main configuration file. This TOML file contain the main configurations such as monitored SC, gateway URL, timings and so on (default: "config/config.toml") |
There was a problem hiding this comment.
Suggested change
| --config [path] The [path] for the main configuration file. This TOML file contain the main configurations such as monitored SC, gateway URL, timings and so on (default: "config/config.toml") | |
| --config [path] The [path] for the main configuration file. This TOML file contains the main configurations such as monitored SC, gateway URL, timings and so on (default: "config/config.toml") |
cmd/scCallsExecutor/README.md
Outdated
| throttling might occur without the access token. | ||
|
|
||
| The `EXTRA_FLAGS` can contain extra flags to be called whenever the application is started. | ||
| The complete list of the cli command can be found [here](./cmd/scCallsExecutor/CLI.md) |
There was a problem hiding this comment.
Suggested change
| The complete list of the cli command can be found [here](./cmd/scCallsExecutor/CLI.md) | |
| The complete list of the cli commands can be found [here](./cmd/scCallsExecutor/CLI.md). |
| HUMAN_TIME=$(date -d @"$GITHUB_API_RESET") | ||
|
|
||
| # Allow user to override the current version to be used | ||
| OVERRIDE_VER="" |
sstanculeanu
approved these changes
Jan 22, 2025
valentin-lup
approved these changes
Jan 22, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.