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

Modify krel Error message when github token env not set #2574

Closed
DiptoChakrabarty opened this issue Jun 17, 2022 · 9 comments · Fixed by #2632
Closed

Modify krel Error message when github token env not set #2574

DiptoChakrabarty opened this issue Jun 17, 2022 · 9 comments · Fixed by #2632
Assignees
Labels
area/release-eng Issues or PRs related to the Release Engineering subproject good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. needs-priority sig/release Categorizes an issue or PR as relevant to SIG Release.

Comments

@DiptoChakrabarty
Copy link
Member

DiptoChakrabarty commented Jun 17, 2022

What would you like to be added:

On running the krel tool when no github token env var is set the error message returned is this
validating command line options: Cannot generate release notes if GitHub token is not set

comparing to the release-notes tool the error message for the same case is this, which gives a better idea of the error
neither environment variable GITHUB_TOKENnorreplay option is set

It would be good if the krel error returned would be something similar to the release notes where we specify that the Github token is the required environment variable
validating command line options: Cannot generate release notes if GitHub token environment variable is not set

Why is this needed:

Error message sounds better compared to previous error message as it can help debug faster and identify the issue

/good-first-issue

@DiptoChakrabarty DiptoChakrabarty added area/release-eng Issues or PRs related to the Release Engineering subproject kind/feature Categorizes issue or PR as related to a new feature. sig/release Categorizes an issue or PR as relevant to SIG Release. labels Jun 17, 2022
@k8s-ci-robot
Copy link
Contributor

@DiptoChakrabarty:
This request has been marked as suitable for new contributors.

Guidelines

Please ensure that the issue body includes answers to the following questions:

  • Why are we solving this issue?
  • To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
  • Does this issue have zero to low barrier of entry?
  • How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.

In response to this:

What would you like to be added:

On running the krel tool when no github token env var is set the error message returned is this
validating command line options: Cannot generate release notes if GitHub token is not set

comparing to the release-notes tool the error message for the same case is this, which gives a better idea of the error
neither environment variable GITHUB_TOKENnorreplay option is set

It would be good if the krel error returned would be something similar to the release notes where we specify that the Github token ithe required environment variable
validating command line options: Cannot generate release notes if GitHub token environment variable is not set

Why is this needed:

Error message sounds better compared to previous error message as it can help debug faster and identify the issue

/good-first-issue

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. needs-priority labels Jun 17, 2022
@saschagrunert
Copy link
Member

@DiptoChakrabarty this makes sense, are you going to work on that and propose a PR? :)

@DiptoChakrabarty
Copy link
Member Author

@saschagrunert Ill keep it open for new contributors , if someone doesnt pick it up in a prolonged period Ill take it up :)

@Nawaz027
Copy link

/assign

@csantanapr
Copy link
Member

thank you @DiptoChakrabarty 👍

@RajGM
Copy link

RajGM commented Jul 24, 2022

Hi @Nawaz027
Are you still working on this issue?

@RajGM
Copy link

RajGM commented Jul 24, 2022

Hi @DiptoChakrabarty
Can somebody else pick this up?

@DiptoChakrabarty
Copy link
Member Author

Sure @RajGM if @Nawaz027 is not working on it assign yourself

@Nawaz027 Nawaz027 removed their assignment Jul 28, 2022
@knowshan
Copy link
Contributor

knowshan commented Aug 6, 2022

/assign

knowshan added a commit to knowshan/release that referenced this issue Aug 6, 2022
k8s-ci-robot added a commit that referenced this issue Aug 13, 2022
chore(krel): update CLI message for GITHUB_TOKEN #2574
wespanther pushed a commit to wespanther/release that referenced this issue Jun 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/release-eng Issues or PRs related to the Release Engineering subproject good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. needs-priority sig/release Categorizes an issue or PR as relevant to SIG Release.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants