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

Making it clearer that the API token needs to be passed via custom headers #604

Merged
merged 1 commit into from
Apr 16, 2024

Conversation

alvinometric
Copy link
Contributor

In the first example that people will see, the Authorization header is like this

customHeaders: { Authorization: 'SOME-SECRET' },

To me it's not super clear that API token needs to be passed via custom headers.

I've also standardised that value throughout the readme.

@coveralls
Copy link

Coverage Status

coverage: 90.863%. remained the same
when pulling ea801a1 on alvin/update-readme
into eb95b44 on main.

Copy link
Contributor

@andreas-unleash andreas-unleash left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for clarifying.

@alvinometric alvinometric merged commit d6cd6af into main Apr 16, 2024
5 checks passed
@alvinometric alvinometric deleted the alvin/update-readme branch April 16, 2024 08:43
renovate bot referenced this pull request in Unleash/unleash Jun 3, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [unleash-client](https://togithub.com/Unleash/unleash-client-node) |
[`5.5.2` ->
`5.5.3`](https://renovatebot.com/diffs/npm/unleash-client/5.5.2/5.5.3) |
[![age](https://developer.mend.io/api/mc/badges/age/npm/unleash-client/5.5.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/unleash-client/5.5.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/unleash-client/5.5.2/5.5.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/unleash-client/5.5.2/5.5.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>Unleash/unleash-client-node (unleash-client)</summary>

###
[`v5.5.3`](https://togithub.com/Unleash/unleash-client-node/releases/tag/v5.5.3)

[Compare
Source](https://togithub.com/Unleash/unleash-client-node/compare/v5.5.2...v5.5.3)

#### What's Changed

- Making it clearer that the API token needs to be passed via custom
headers by [@&#8203;alvinometric](https://togithub.com/alvinometric) in
[https://github.com/Unleash/unleash-client-node/pull/604](https://togithub.com/Unleash/unleash-client-node/pull/604)
- Updated README to use ESM by
[@&#8203;alvinometric](https://togithub.com/alvinometric) in
[https://github.com/Unleash/unleash-client-node/pull/605](https://togithub.com/Unleash/unleash-client-node/pull/605)
- chore(deps): update dependency typescript to v5.4.5 by
[@&#8203;renovate](https://togithub.com/renovate) in
[https://github.com/Unleash/unleash-client-node/pull/600](https://togithub.com/Unleash/unleash-client-node/pull/600)
- chore(deps): update dependency semver to v7.6.1 by
[@&#8203;renovate](https://togithub.com/renovate) in
[https://github.com/Unleash/unleash-client-node/pull/607](https://togithub.com/Unleash/unleash-client-node/pull/607)
- chore(deps): update dependency sinon to v17.0.2 by
[@&#8203;renovate](https://togithub.com/renovate) in
[https://github.com/Unleash/unleash-client-node/pull/608](https://togithub.com/Unleash/unleash-client-node/pull/608)
- chore(deps): bump tar from 6.1.13 to 6.2.1 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/Unleash/unleash-client-node/pull/603](https://togithub.com/Unleash/unleash-client-node/pull/603)
- chore(deps): update dependency sinon to v18 by
[@&#8203;renovate](https://togithub.com/renovate) in
[https://github.com/Unleash/unleash-client-node/pull/613](https://togithub.com/Unleash/unleash-client-node/pull/613)
- chore(deps): update dependency semver to v7.6.2 by
[@&#8203;renovate](https://togithub.com/renovate) in
[https://github.com/Unleash/unleash-client-node/pull/612](https://togithub.com/Unleash/unleash-client-node/pull/612)
- chore(deps): update dependency eslint to v8.57.0 by
[@&#8203;renovate](https://togithub.com/renovate) in
[https://github.com/Unleash/unleash-client-node/pull/610](https://togithub.com/Unleash/unleash-client-node/pull/610)
- Fixes Unleash client stops fetching
[#&#8203;615](https://togithub.com/Unleash/unleash-client-node/issues/615)
by [@&#8203;HenrikBacher](https://togithub.com/HenrikBacher) in
[https://github.com/Unleash/unleash-client-node/pull/616](https://togithub.com/Unleash/unleash-client-node/pull/616)

#### New Contributors

- [@&#8203;alvinometric](https://togithub.com/alvinometric) made their
first contribution in
[https://github.com/Unleash/unleash-client-node/pull/604](https://togithub.com/Unleash/unleash-client-node/pull/604)
- [@&#8203;HenrikBacher](https://togithub.com/HenrikBacher) made their
first contribution in
[https://github.com/Unleash/unleash-client-node/pull/616](https://togithub.com/Unleash/unleash-client-node/pull/616)

**Full Changelog**:
Unleash/unleash-client-node@v5.5.2...v5.5.3

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "after 7pm every weekday,before 5am
every weekday" in timezone Europe/Madrid, Automerge - At any time (no
schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/Unleash/unleash).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zNzcuOCIsInVwZGF0ZWRJblZlciI6IjM3LjM3Ny44IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
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.

None yet

3 participants