Skip to content

[GSK-1608] Update token nomenclature of CLI parameters #1414

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 11 commits into from
Oct 3, 2023
Merged

[GSK-1608] Update token nomenclature of CLI parameters #1414

merged 11 commits into from
Oct 3, 2023

Conversation

@henchaves
Copy link
Member

@henchaves henchaves commented Sep 21, 2023 •
edited
Loading

Description

To enhance the naming convention of third-party tokens used as CLI parameters, we propose avoiding the use of tags such as --token for Ngrok token and -t for HF Spaces token. These tags should only be reserved for internal tokens.

Also, all the API Access Tokens are replaced with API Access Key.

Related Issue

GSK-1608 (available on Linear)

  • 📚 Examples / docs / tutorials / dependencies update
  • 🔧 Bug fix (non-breaking change which fixes an issue)
  • 🥂 Improvement (non-breaking change which improves an existing feature)
  • 🚀 New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to change)
  • 🔐 Security fix

@linear
Copy link

linear bot commented Sep 21, 2023

GSK-1608 Make token names and cli arguments uniform

HuggingFace Token as --hf-token
Ngrok API Token as --ngrok-token

Don't use the CLI short argument -t to any third party token.

Update docs and notebooks

@henchaves henchaves self-assigned this Sep 21, 2023
@henchaves henchaves marked this pull request as ready for review September 25, 2023 18:57
@henchaves henchaves added documentation Improvements or additions to documentation Python Pull requests that update Python code Frontend labels Sep 25, 2023
@sonarqubecloud
Copy link

sonarqubecloud bot commented Oct 3, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

0.0% 0.0% Coverage
0.0% 0.0% Duplication

@kevinmessiaen kevinmessiaen merged commit 8032190 into main Oct 3, 2023
@kevinmessiaen kevinmessiaen deleted the feature/gsk-1608-make-token-names-and-cli-arguments-uniform branch October 3, 2023 05:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kevinmessiaen kevinmessiaen kevinmessiaen approved these changes

@andreybavt andreybavt Awaiting requested review from andreybavt

Assignees

@henchaves henchaves

Labels

documentation Improvements or additions to documentation Frontend Python Pull requests that update Python code

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@henchaves @kevinmessiaen