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

Improve help on tokens #34

Merged
merged 1 commit into from
Feb 17, 2021
Merged

Improve help on tokens #34

merged 1 commit into from
Feb 17, 2021

Conversation

lukasmalkmus
Copy link
Collaborator

@lukasmalkmus lukasmalkmus commented Feb 17, 2021

This PR improves the user experience by adding two things:

  • An additional help topic on the different token types and how they affect the CLI usage
  • An explicit error message when running commands which do not support using an ingest-only token

Screenshot 2021-02-17 at 12 29 35

Overriding the token by flag or environment bypasses the check by assuming a personal token was passed. This is crucial because a deployment can be configured with an ingest token but a personal token can be specified as override.

@lukasmalkmus lukasmalkmus added the enhancement New feature or request label Feb 17, 2021
@lukasmalkmus lukasmalkmus added this to the v0.2.0 milestone Feb 17, 2021
@lukasmalkmus lukasmalkmus enabled auto-merge (rebase) February 17, 2021 11:42
@codecov
Copy link

codecov bot commented Feb 17, 2021

Codecov Report

Merging #34 (48b23f7) into main (de7d888) will decrease coverage by 0.23%.
The diff coverage is 0.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #34      +/-   ##
==========================================
- Coverage   14.78%   14.54%   -0.24%     
==========================================
  Files           9        9              
  Lines         487      495       +8     
==========================================
  Hits           72       72              
- Misses        400      408       +8     
  Partials       15       15              
Impacted Files Coverage Δ
cmd/axiom/root/help.go 0.00% <0.00%> (ø)
cmd/axiom/root/help_topic.go 100.00% <ø> (ø)
cmd/axiom/root/root.go 0.00% <0.00%> (ø)
internal/config/config.go 5.71% <0.00%> (-0.17%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update de7d888...bd7e34d. Read the comment docs.

@bahlo
Copy link
Member

bahlo commented Feb 17, 2021

Love it. Would be even better if there was a command to "upgrade" a token. You could suggest that in the help even

@lukasmalkmus lukasmalkmus merged commit c27e9eb into main Feb 17, 2021
@lukasmalkmus lukasmalkmus deleted the token-help-and-guidance branch February 17, 2021 12:54
@bahlo bahlo mentioned this pull request Feb 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants