Skip to content

Commit

Permalink
Update the CLI flag docstrings
Browse files Browse the repository at this point in the history
Signed-off-by: Noah Stride <[email protected]>
  • Loading branch information
strideynet committed Oct 18, 2024
1 parent 7e15c4b commit d87a60f
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions cmd/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -78,15 +78,14 @@ func newX509CredentialProcessCmd() *cobra.Command {
return nil
},
}
// TODO(strideynet): Review flag help strings.
cmd.Flags().StringVar(&roleARN, "role-arn", "", "TODO. Required.")
cmd.Flags().StringVar(&roleARN, "role-arn", "", "The ARN of the role to assume. Required.")
cmd.MarkFlagRequired("role-arn")

Check failure on line 82 in cmd/main.go

View workflow job for this annotation

GitHub Actions / lint

Error return value of `cmd.MarkFlagRequired` is not checked (errcheck)
cmd.Flags().StringVar(&region, "region", "", "TODO")
cmd.Flags().StringVar(&profileARN, "profile-arn", "", "TODO. Required.")
cmd.Flags().StringVar(&region, "region", "", "The AWS region to use. Optional.")
cmd.Flags().StringVar(&profileARN, "profile-arn", "", "The ARN of the Roles Anywhere profile to use. Required.")
cmd.MarkFlagRequired("profile-arn")

Check failure on line 85 in cmd/main.go

View workflow job for this annotation

GitHub Actions / lint

Error return value of `cmd.MarkFlagRequired` is not checked (errcheck)
cmd.Flags().DurationVar(&sessionDuration, "session-duration", 0, "TODO")
cmd.Flags().StringVar(&trustAnchorARN, "trust-anchor-arn", "", "TODO. Required.")
cmd.Flags().DurationVar(&sessionDuration, "session-duration", 0, "The duration of the resulting session. Optional. Can range from 15m to 12h.")
cmd.Flags().StringVar(&trustAnchorARN, "trust-anchor-arn", "", "The ARN of the Roles Anywhere trust anchor to use. Required.")
cmd.MarkFlagRequired("trust-anchor-arn")

Check failure on line 88 in cmd/main.go

View workflow job for this annotation

GitHub Actions / lint

Error return value of `cmd.MarkFlagRequired` is not checked (errcheck)
cmd.Flags().StringVar(&roleSessionName, "role-session-name", "", "TODO")
cmd.Flags().StringVar(&roleSessionName, "role-session-name", "", "The identifier for the role session. Optional.")
return cmd
}

0 comments on commit d87a60f

Please sign in to comment.