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

CLI for creating config.yaml #413

Merged
merged 8 commits into from
Apr 25, 2024
Merged

CLI for creating config.yaml #413

merged 8 commits into from
Apr 25, 2024

Conversation

nkoenig
Copy link
Contributor

@nkoenig nkoenig commented Apr 9, 2024

🎉 New feature

Summary

This simplifies the process of creating a config.yaml file by supporting the gz fuel configure CLI. This new CLI walks a user through the process of creating a config.yaml file that will live in ~/.gz/fuel/.

The primary benefit is that it makes it easier to store and then use private access tokens.

Test it

  1. Run the full guided process with:
gz fuel configure
  1. Accept the defaults, and create a standard config file.
gz fuel configure --defaults
  1. Accept the defaults, and output the result to the console.
gz fuel configure --defaults --console

Checklist

  • Signed all commits for DCO
  • Added tests
  • Added example and/or tutorial
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

@github-actions github-actions bot added the 🌱 garden Ignition Garden label Apr 9, 2024
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
tutorials/02_configuration.md Outdated Show resolved Hide resolved
Signed-off-by: Nate Koenig <[email protected]>
@nkoenig nkoenig requested a review from ahcorde April 10, 2024 21:28
@nkoenig
Copy link
Contributor Author

nkoenig commented Apr 25, 2024

@ahcorde , can I get a quick re-review please? All the tests are now passing.

@ahcorde ahcorde merged commit d14ffcd into gz-fuel-tools8 Apr 25, 2024
9 checks passed
@ahcorde ahcorde deleted the nkoenig/configure-cli branch April 25, 2024 12:58
azeey added a commit to gazebo-release/gz-fuel-tools9-release that referenced this pull request Aug 7, 2024
The config.yaml is no longer installed by the upstream code as of
gazebosim/gz-fuel-tools#413

Signed-off-by: Addisu Z. Taddese <[email protected]>
azeey added a commit to gazebo-release/gz-fuel-tools9-release that referenced this pull request Aug 7, 2024
…#3)

The config.yaml is no longer installed by the upstream code as of
gazebosim/gz-fuel-tools#413

Signed-off-by: Addisu Z. Taddese <[email protected]>
j-rivero added a commit to gazebo-release/gz-fuel-tools8-release that referenced this pull request Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🌱 garden Ignition Garden
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants