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

fix example flag names #1630

Merged
merged 6 commits into from
Apr 24, 2024
Merged

fix example flag names #1630

merged 6 commits into from
Apr 24, 2024

Conversation

aliotta
Copy link
Contributor

@aliotta aliotta commented Apr 23, 2024

Description

Fixes the flag name of used in the example text for the deployment token management

🎟 Issue(s)

Related #XXX

🧪 Functional Testing

List the functional testing steps to confirm this feature or fix.

📸 Screenshots

Add screenshots to illustrate the validity of these changes.

📋 Checklist

  • Rebased from the main (or release if patching) branch (before testing)
  • Ran make test before taking out of draft
  • Ran make lint before taking out of draft
  • Added/updated applicable tests
  • Tested against Astro-API (if necessary).
  • Tested against Houston-API and Astronomer (if necessary).
  • Communicated to/tagged owners of respective clients potentially impacted by these changes.
  • Updated any related documentation

Copy link

codecov bot commented Apr 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.75%. Comparing base (eeffcf9) to head (dd309e8).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1630   +/-   ##
=======================================
  Coverage   86.75%   86.75%           
=======================================
  Files         114      114           
  Lines       16661    16661           
=======================================
  Hits        14454    14454           
  Misses       1318     1318           
  Partials      889      889           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@@ -1069,7 +1069,7 @@ func newAddOrganizationTokenDeploymentRole(out io.Writer) *cobra.Command {
cmd := &cobra.Command{
Use: "add [ORG_TOKEN_ID]",
Short: "Add an Organization API token to a Deployment",
Long: "Add an Organization API token to a Deployment\n$astro deployment token organization-token add [ORG_TOKEN_ID] --name [token name] --role [DEPLOYMENT_ADMIN or a custom role name].",
Long: "Add an Organization API token to a Deployment\n$astro deployment token organization-token add [ORG_TOKEN_ID] --org-token-name [token name] --role [DEPLOYMENT_ADMIN or a custom role name].",
Copy link
Contributor

Choose a reason for hiding this comment

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

any unit tests we can add for these?

@@ -457,7 +457,7 @@ func newRemoveOrganizationTokenWorkspaceRole(out io.Writer) *cobra.Command {
cmd := &cobra.Command{
Use: "remove [ORG_TOKEN_ID]",
Short: "Remove an Workspace API token's Deployment Role",
Long: "Remove an Workspace API token's Deployment Role\n$astro workspace token organization-token remove [ORG_TOKEN_ID] --name [token name].",
Long: "Remove an Workspace API token's Deployment Role\n$astro workspace token organization-token remove [ORG_TOKEN_ID] --org-token-name [token name].",
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this correct? The function name is different from what we are calling.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

it was not good eyes. Should be good now.

@aliotta aliotta requested a review from kushalmalani April 23, 2024 21:59
Short: "Remove an Workspace API token's Deployment Role",
Long: "Remove an Workspace API token's Deployment Role\n$astro workspace token organization-token remove [ORG_TOKEN_ID] --name [token name].",
Short: "Remove an Organization API token's Workspace Role",
Long: "Remove an Organization API token's Workspace Role\n$astro workspace token organization-token remove [ORG_TOKEN_ID] --org-token-name [token name].",
RunE: func(cmd *cobra.Command, args []string) error {
return removeWorkspaceTokenFromDeploymentRole(cmd, args, out)
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this need updating too then?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yep done.

@aliotta aliotta merged commit c9c2d0d into main Apr 24, 2024
4 of 5 checks passed
@aliotta aliotta deleted the fixExampleTestForOrgTokenManagement branch April 24, 2024 16:42
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.

3 participants