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

Remove plural from API secret #146

Merged
merged 1 commit into from
Sep 19, 2022
Merged

Remove plural from API secret #146

merged 1 commit into from
Sep 19, 2022

Conversation

mjayaram
Copy link
Contributor

This is a bit confusing and inconsistent. In particular, in the baseline buildevent library README, it is suggested to use BUILDEVENT_APIKEY. And that is consistent with the CircleCI orb docs.

If people are going between the two docs it is very possible that they will introduce a hard to identify bug.

NOTE: this requires updating of the new guide. If this PR is merged, I will take that on immediately following.

This is a bit confusing and inconsistent. In particular, in the [baseline buildevent library README](https://github.com/honeycombio/buildevents#environment-variables), it is suggested to use `BUILDEVENT_APIKEY`. And that is consistent with the [CircleCI orb docs](https://github.com/honeycombio/buildevents-orb#overview).

If people are going between the two docs it is very possible that they will introduce a hard to identify bug.

NOTE: this requires updating of the new guide. If this PR is merged, I will take that on immediately following.
@mjayaram mjayaram marked this pull request as ready for review September 19, 2022 19:53
@mjayaram mjayaram requested a review from a team as a code owner September 19, 2022 19:53
@mjayaram mjayaram merged commit be2b082 into main Sep 19, 2022
@mjayaram mjayaram deleted the abangser/patch-1 branch September 19, 2022 19:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants