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

docs(readme): update README to include the minimum node.js version #726

Merged
merged 2 commits into from
May 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ A JavaScript client library for the Duffel API.

## Prerequisites

- Node >= 14.17.6
- Node >= 18.16.0

## Install

Expand Down
8 changes: 7 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,13 @@
"@semantic-release/release-notes-generator"
],
"@semantic-release/npm",
"@semantic-release/github"
[
"@semantic-release/github",
{
"successComment": false,
"failTitle": false
}
]
Comment on lines +104 to +110
Copy link
Contributor

Choose a reason for hiding this comment

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

This seems unrelated – what's the background here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, sorry I should have mentioned this on the description (which I will add). This is because of this: https://github.com/duffelhq/duffel-api-javascript/actions/runs/4881478277/jobs/8710431028

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah thanks for the context. I'm still a bit confused though – the thing you linked to mentions that we've hit a rate limiting issue?

Copy link
Contributor Author

@lapa182 lapa182 May 4, 2023

Choose a reason for hiding this comment

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

Yes, indeed. This is because every time we publish a new release we comment on GH issues which causes our workflow to fail if rate limited by GH. Please see semantic-release/semantic-release#2204 for further informations on the work-around and issue

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah I see – thanks! It's a shame we can't add comments to package.json to give more context, but we can always check the git blame for it in the future and find this PR at least

],
"branches": [
"main"
Expand Down