Skip to content

Update CLI descriptions and their reference in the README.md file #153

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

Merged

Conversation

rdimitrov
Copy link
Contributor

@rdimitrov rdimitrov commented Sep 14, 2021

The following PR updates the descriptions we provide for the CLI options along with some additional housekeeping.

Details:

  • Added .gitignore file for ignoring tuf and tuf-client executables
  • Added entry for init in the tuf help message
  • Added documentation about the use of environment variables for passing each role's passphrases -TUF_{{ROLE}}_PASSPHRASE closing Add documentation for passphrase environment variables #73
  • Added documentation for revoke-key in README.md - closing Document ability to revoke / remove keys #85
  • Added a "not-supported-yet" status for the regenerate command as it's still not implemented
  • Updated the info for the sign command in the README.md file - it expects a role metadata filename (i.e. targets.json) instead of just the name of the role

@coveralls
Copy link

coveralls commented Sep 14, 2021

Pull Request Test Coverage Report for Build 1233929670

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 69.512%

Totals Coverage Status
Change from base Build 1221339773: 0.0%
Covered Lines: 1808
Relevant Lines: 2601

💛 - Coveralls

@rdimitrov rdimitrov force-pushed the dimitrovr/add-passphrase-env-usage branch from a7c7b63 to 60ac33d Compare September 14, 2021 13:59
@rdimitrov rdimitrov requested a review from mnm678 September 16, 2021 08:42
@asraa asraa merged commit f38e930 into theupdateframework:master Sep 17, 2021
@rdimitrov rdimitrov deleted the dimitrovr/add-passphrase-env-usage branch September 20, 2021 12:21
mnm678 pushed a commit to mnm678/go-tuf that referenced this pull request Oct 21, 2021
…eupdateframework#153)

* Update CLI descriptions and their reference in the README.md file

Signed-off-by: Radoslav Dimitrov <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants