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

Suggestion: also support README_API_KEY in addition to RDME_API_KEY #948

Closed
nickcampbell18 opened this issue Dec 1, 2023 · 4 comments · Fixed by #950
Closed

Suggestion: also support README_API_KEY in addition to RDME_API_KEY #948

nickcampbell18 opened this issue Dec 1, 2023 · 4 comments · Fixed by #950
Labels
enhancement New feature or request good first issue Good for newcomers released
Milestone

Comments

@nickcampbell18
Copy link

Hi folks 👋

We recently switched from using the GitHub action to a shell script, because we wanted some extra automation around the deployment. Locally we use rdme login, but in CI we just use an API key.

Anyway, I exported the environment variable README_API_KEY based on the secret we'd set for the action - ${{ secrets.README_API_KEY }} - but my command failed telling me I needed a --key argument. It was only after re-reading the docs I noticed the subtle difference and I should have used RDME_...!

Do you think it might be worth also checking for README_API_KEY in addition to the existing one? Seems unlikely I would be using README_API_KEY to do something else, so this could be a neat ergonomics improvement IMO.

@kanadgupta kanadgupta added enhancement New feature or request good first issue Good for newcomers labels Dec 1, 2023
@kanadgupta kanadgupta added this to the v9 milestone Dec 1, 2023
@kanadgupta
Copy link
Member

Hey @nickcampbell18 — definitely agreed here. Will make sure this enhancement is included in v9!

@serverlessmike

This comment was marked as off-topic.

@kanadgupta
Copy link
Member

@nickcampbell18 this change was added in 9.0.0-next.8. Thanks for writing in about this!

https://github.com/readmeio/rdme/releases/tag/9.0.0-next.8
https://www.npmjs.com/package/rdme/v/9.0.0-next.8

@kanadgupta
Copy link
Member

🎉 This issue has been resolved in version 9.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers released
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants