fix: pin Keygen integration to API v1.0 #6909
Merged
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
🦋 Changeset detectedLatest commit: 5e9ccd0 The changes in this PR will be included in the next version bump. This PR includes changesets to release 9 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
✅ Deploy Preview for car-park-attendant-cleat-11576 ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
ezekg
changed the title
|
@ezekg thanks for the PR! Can you also add a changeset file for this via |
ezekg
changed the title
ezekg
force-pushed
the
feature/lock-keygen-api-version
branch
from
d06b072
to
a033aa2
Compare
|
@mmaietta done! |
ezekg
changed the title
chore: add changeset
ezekg
force-pushed
the
feature/lock-keygen-api-version
branch
from
a033aa2
to
5e9ccd0
Compare
Merged
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.
As part of an upcoming change to Keygen's API, we need to pin electron-builder's integration to v1.0 of Keygen's API so that newer Keygen users on v1.1 (the soon-to-be new default) can still utilize the current integration as-is. I wanted to get this integration updated before we roll out the newer API version in the coming weeks.
Below is a list of notable things that will be changing in v1.1 of Keygen's API:
PUT /releases/<release>/artifact.statusattribute has been to the Release object, which can beDRAFTorPUBLISHED. New Release objects will default to a draft state and must be explicitly published before being made available for upgrades.filename,filetype,filesize,platform,signature, andchecksum.PUT /releases, has been deprecated.Essentially, the gist of the change set here is around refactoring Releases to be a versioned "bucket" for Artifacts, rather than a one-to-one relationship between a Release and Artifact. The new object model gets rid of a lot of confusing problems that the previous modeling had, such as conflicting versions when a filetype or filename matched a previous Release.
In v1.1 of Keygen's API, multiple Releases can have Artifacts that have the same filename, e.g.
latest-mac.yml, and the latest will be retrieved when requesting a particular Artifact by filename, e.g.GET /artifacts/<filename>.These API changes are being made in a backwards-compatible way, with the
Keygen-Versionheader used to communicate which API version is requested. All existing electron-builder integrations will continue to work.I'm going to create a follow up PR that refactors the integration to use v1.1 of Keygen's API.