fix: replace escaped newlines with actual newlines in privateKey values #96
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
fyi this is the first pull request I generated using a Copilot Workspace. Other than generating a test file, it's a pretty great start! |
gr2m
changed the title
|
also fyi I ran into this so often, and so others run into this even more, that I decided to just go ahead and implement this convenience fix. I'm not sure about the performance implications, if necessary we could check a subset of the private key string instead all of it, but I'd expect the performance implications to be negligible |
|
🎉 This PR is included in version 2.1.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
feedmypixel
added a commit
to DEFRA/cdp-self-service-ops
that referenced
this pull request
Jan 22, 2025
So with the bump of @octokit/auth-app from v6.* -> v7.* it bumped its own dependency of universal-github-app-jwt from v1.* -> v2.* The universal-github-app-jwt v2 has introduced some work that replaces newlines within private keys - https://github.com/gr2m/universal-github-app-jwt/blob/d52064d3395a02363b6f80afeeb5d91e0a5f2040/index.js#L17 This work looks like it came in in v2.1.1 - gr2m/universal-github-app-jwt#96 Essentially what this means is with the latest version the privateKey must be a string rather than a buffer. This code fixes this issue
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Implements automatic newline conversion for private keys and updates documentation accordingly.
index.jsto automatically replace escaped newlines (\\n) in theprivateKeyargument with actual newline characters before passing it to thegetToken()function. This ensures compatibility with private keys defined in environment variables or other sources where newlines are escaped.README.mdfile by adding a note under theoptions.privateKeysection. It now informs users that escaped newlines in the private key will be automatically replaced with actual newline characters, accommodating private keys stored with escaped newlines.For more details, open the Copilot Workspace session.