doc: Improve CLI parameters DOCS-180 #92
Merged
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
nicklem
commented
Dec 7, 2022
nicklem
commented
Dec 7, 2022
nicklem
force-pushed
the
doc/cli-options-DOCS-180
branch
2 times, most recently
from
c6fe629
to
22c958b
Compare
nicklem
commented
Dec 9, 2022
| output: | ||
| required: false | ||
| description: "Send analysis results to an output file" | ||
| description: "Path to a file to save the analysis results" |
There was a problem hiding this comment.
I tested this and I suspect that this only works for a local CLI analysis with file system access. It seems to timeout on a GitHub workflow.
Should this even be flagged as supported? Are there other options like this one?
There was a problem hiding this comment.
Perhaps with the client side tools integration? Haven't tested that one...
There was a problem hiding this comment.
I'm not sure about this either. 🤔 Let's keep this thread open and we'll check again with some more time later.
There was a problem hiding this comment.
Now that I had a look at the workflow execution output, I'm thinking that perhaps it was something else that caused the GitHub Action to time out. 🤔
Could you please try running it again and see what happens?
There was a problem hiding this comment.
Yes, the file is probably created correctly at the end of the Codacy Analysis CLI run. But I don't think it's necessary to further clarify this, as it isn't even very clear why anyone would want to use this option (save for maybe uploading it as an artifact of the workflow that could then be consulted later for debugging purposes.).
prcr
suggested changes
Dec 12, 2022
There was a problem hiding this comment.
Very good proposal and improvements to the descriptions of the input parameters! 🙌
- Sort action.yml parameters alphabetically
The parameters are ordered in a way that has some logic to it; for example, the first parameters are more "core", while the last ones all have to do with client-side tools. The order can be improved for sure, but by sorting them alphabetically we'll lose this "implicit information" that currently exists.
I left review comments, please address them and then we'll do another pass to settle any remaining details.
| output: | ||
| required: false | ||
| description: "Send analysis results to an output file" | ||
| description: "Path to a file to save the analysis results" |
There was a problem hiding this comment.
I'm not sure about this either. 🤔 Let's keep this thread open and we'll check again with some more time later.
prcr
reviewed
Dec 12, 2022
| output: | ||
| required: false | ||
| description: "Send analysis results to an output file" | ||
| description: "Path to a file to save the analysis results" |
There was a problem hiding this comment.
Now that I had a look at the workflow execution output, I'm thinking that perhaps it was something else that caused the GitHub Action to time out. 🤔
Could you please try running it again and see what happens?
prcr
previously approved these changes
Dec 13, 2022
nicklem
force-pushed
the
doc/cli-options-DOCS-180
branch
from
49a562c
to
bfca6ba
Compare
|
@prcr I force-pushed to clean up the commit messages. |
🎉
gsuquet
referenced
this pull request
in gsuquet/workflows
Jul 19, 2024
…114) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [codacy/codacy-analysis-cli-action](https://github.com/codacy/codacy-analysis-cli-action) | action | patch | `v4.4.1` -> `v4.4.4` | --- ### Release Notes <details> <summary>codacy/codacy-analysis-cli-action (codacy/codacy-analysis-cli-action)</summary> ### [`v4.4.4`](https://github.com/codacy/codacy-analysis-cli-action/releases/tag/v4.4.4) [Compare Source](https://github.com/codacy/codacy-analysis-cli-action/compare/v4.4.3...v4.4.4) #### What's Changed - update cli version to 7.9.11 by [@​hjrocha](https://github.com/hjrocha) in [https://github.com/codacy/codacy-analysis-cli-action/pull/132](https://github.com/codacy/codacy-analysis-cli-action/pull/132) ### [`v4.4.3`](https://github.com/codacy/codacy-analysis-cli-action/releases/tag/v4.4.3) [Compare Source](https://github.com/codacy/codacy-analysis-cli-action/compare/v4.4.2...v4.4.3) #### What's Changed - fix registry-address default value by [@​hjrocha](https://github.com/hjrocha) in [https://github.com/codacy/codacy-analysis-cli-action/pull/131](https://github.com/codacy/codacy-analysis-cli-action/pull/131) ### [`v4.4.2`](https://github.com/codacy/codacy-analysis-cli-action/releases/tag/v4.4.2) [Compare Source](https://github.com/codacy/codacy-analysis-cli-action/compare/v4.4.1...v4.4.2) #### What's Changed - Fixed some broken links by [@​mushlih-almubarak](https://github.com/mushlih-almubarak) in [https://github.com/codacy/codacy-analysis-cli-action/pull/77](https://github.com/codacy/codacy-analysis-cli-action/pull/77) - bump: Bump codacy-analysis-cli to 7.6.4 CY-6112 by [@​lolgab](https://github.com/lolgab) in [https://github.com/codacy/codacy-analysis-cli-action/pull/80](https://github.com/codacy/codacy-analysis-cli-action/pull/80) - feature: Introduce new versioning scheme `vX.X.X` by [@​lolgab](https://github.com/lolgab) in [https://github.com/codacy/codacy-analysis-cli-action/pull/81](https://github.com/codacy/codacy-analysis-cli-action/pull/81) - doc: Mention setting up the Go environment DOCS-380 by [@​prcr](https://github.com/prcr) in [https://github.com/codacy/codacy-analysis-cli-action/pull/83](https://github.com/codacy/codacy-analysis-cli-action/pull/83) - \[SE-140] Add max-tool-memory flag by [@​heliocodacy](https://github.com/heliocodacy) in [https://github.com/codacy/codacy-analysis-cli-action/pull/86](https://github.com/codacy/codacy-analysis-cli-action/pull/86) - Bump gosec to v2.13.1 CY-6239 by [@​stefanvacareanu7](https://github.com/stefanvacareanu7) in [https://github.com/codacy/codacy-analysis-cli-action/pull/87](https://github.com/codacy/codacy-analysis-cli-action/pull/87) - Fix typo by [@​pSub](https://github.com/pSub) in [https://github.com/codacy/codacy-analysis-cli-action/pull/82](https://github.com/codacy/codacy-analysis-cli-action/pull/82) - doc: Bump supported Go version to 1.19.1 CY-6239 by [@​prcr](https://github.com/prcr) in [https://github.com/codacy/codacy-analysis-cli-action/pull/88](https://github.com/codacy/codacy-analysis-cli-action/pull/88) - Update supported languages count by [@​nicklem](https://github.com/nicklem) in [https://github.com/codacy/codacy-analysis-cli-action/pull/91](https://github.com/codacy/codacy-analysis-cli-action/pull/91) - doc: Improve CLI parameters DOCS-180 by [@​nicklem](https://github.com/nicklem) in [https://github.com/codacy/codacy-analysis-cli-action/pull/92](https://github.com/codacy/codacy-analysis-cli-action/pull/92) - doc: Flag [@​codacy/techwriters](https://github.com/codacy/techwriters) as owners of README.md DOCS-483 by [@​nicklem](https://github.com/nicklem) in [https://github.com/codacy/codacy-analysis-cli-action/pull/93](https://github.com/codacy/codacy-analysis-cli-action/pull/93) - added github_token in all requests to github api in action.yml by [@​DMarinhoCodacy](https://github.com/DMarinhoCodacy) in [https://github.com/codacy/codacy-analysis-cli-action/pull/96](https://github.com/codacy/codacy-analysis-cli-action/pull/96) - removed github-token from action.yaml file by [@​DMarinhoCodacy](https://github.com/DMarinhoCodacy) in [https://github.com/codacy/codacy-analysis-cli-action/pull/100](https://github.com/codacy/codacy-analysis-cli-action/pull/100) - changed staticcheck URL using github api to artifact TS-214 by [@​DMarinhoCodacy](https://github.com/DMarinhoCodacy) in [https://github.com/codacy/codacy-analysis-cli-action/pull/102](https://github.com/codacy/codacy-analysis-cli-action/pull/102) - updated Clang-Tidy URL to artifact by [@​DMarinhoCodacy](https://github.com/DMarinhoCodacy) in [https://github.com/codacy/codacy-analysis-cli-action/pull/103](https://github.com/codacy/codacy-analysis-cli-action/pull/103) - doc: Mention turning on and configuring the client-side tool by [@​prcr](https://github.com/prcr) in [https://github.com/codacy/codacy-analysis-cli-action/pull/106](https://github.com/codacy/codacy-analysis-cli-action/pull/106) - moved gosec and fauxpas to artifact by [@​DMarinhoCodacy](https://github.com/DMarinhoCodacy) in [https://github.com/codacy/codacy-analysis-cli-action/pull/107](https://github.com/codacy/codacy-analysis-cli-action/pull/107) - fix installation staticcheck using official binary by [@​DMarinhoCodacy](https://github.com/DMarinhoCodacy) in [https://github.com/codacy/codacy-analysis-cli-action/pull/108](https://github.com/codacy/codacy-analysis-cli-action/pull/108) - feature: allow skipping container engine check IO-423 by [@​pedrocodacy](https://github.com/pedrocodacy) in [https://github.com/codacy/codacy-analysis-cli-action/pull/110](https://github.com/codacy/codacy-analysis-cli-action/pull/110) - close if statement properly by [@​bjarkebm](https://github.com/bjarkebm) in [https://github.com/codacy/codacy-analysis-cli-action/pull/114](https://github.com/codacy/codacy-analysis-cli-action/pull/114) - bump cli version by [@​pedrocodacy](https://github.com/pedrocodacy) in [https://github.com/codacy/codacy-analysis-cli-action/pull/116](https://github.com/codacy/codacy-analysis-cli-action/pull/116) - doc: Update Codacy logo DOCS-594 by [@​nicklem](https://github.com/nicklem) in [https://github.com/codacy/codacy-analysis-cli-action/pull/119](https://github.com/codacy/codacy-analysis-cli-action/pull/119) - action: prevent globbing with double quotes by [@​ljmf00](https://github.com/ljmf00) in [https://github.com/codacy/codacy-analysis-cli-action/pull/68](https://github.com/codacy/codacy-analysis-cli-action/pull/68) - Bump cli, staticheck, gosec versions TCE-614 by [@​stefanvacareanu7](https://github.com/stefanvacareanu7) in [https://github.com/codacy/codacy-analysis-cli-action/pull/124](https://github.com/codacy/codacy-analysis-cli-action/pull/124) - TCE-937 add condition to setup go only if the user wants to run staticcheck by [@​DMarinhoCodacy](https://github.com/DMarinhoCodacy) in [https://github.com/codacy/codacy-analysis-cli-action/pull/126](https://github.com/codacy/codacy-analysis-cli-action/pull/126) - feat: \[TCE-1039] Add parameter 'registry-address' in order to support alternative registry addresses by [@​heliocodacy](https://github.com/heliocodacy) in [https://github.com/codacy/codacy-analysis-cli-action/pull/129](https://github.com/codacy/codacy-analysis-cli-action/pull/129) #### New Contributors - [@​mushlih-almubarak](https://github.com/mushlih-almubarak) made their first contribution in [https://github.com/codacy/codacy-analysis-cli-action/pull/77](https://github.com/codacy/codacy-analysis-cli-action/pull/77) - [@​stefanvacareanu7](https://github.com/stefanvacareanu7) made their first contribution in [https://github.com/codacy/codacy-analysis-cli-action/pull/87](https://github.com/codacy/codacy-analysis-cli-action/pull/87) - [@​pSub](https://github.com/pSub) made their first contribution in [https://github.com/codacy/codacy-analysis-cli-action/pull/82](https://github.com/codacy/codacy-analysis-cli-action/pull/82) - [@​nicklem](https://github.com/nicklem) made their first contribution in [https://github.com/codacy/codacy-analysis-cli-action/pull/91](https://github.com/codacy/codacy-analysis-cli-action/pull/91) - [@​DMarinhoCodacy](https://github.com/DMarinhoCodacy) made their first contribution in [https://github.com/codacy/codacy-analysis-cli-action/pull/96](https://github.com/codacy/codacy-analysis-cli-action/pull/96) - [@​bjarkebm](https://github.com/bjarkebm) made their first contribution in [https://github.com/codacy/codacy-analysis-cli-action/pull/114](https://github.com/codacy/codacy-analysis-cli-action/pull/114) - [@​ljmf00](https://github.com/ljmf00) made their first contribution in [https://github.com/codacy/codacy-analysis-cli-action/pull/68](https://github.com/codacy/codacy-analysis-cli-action/pull/68) **Full Changelog**: codacy/codacy-analysis-cli-action@4.0.2...v4.4.2 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MjAuMSIsInVwZGF0ZWRJblZlciI6IjM3LjQyMC4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJyZW5vdmF0ZSJdfQ==--> Signed-off-by: Renovate Bot <bot@renovateapp.com> Co-authored-by: renovate-gsuquet[bot] <173481049+renovate-gsuquet[bot]@users.noreply.github.com>
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.
👀 Preview
https://github.com/codacy/codacy-analysis-cli-action/tree/doc/cli-options-DOCS-180#parameters
To do
action.ymlparameters alphabetically