feat(core): Use lerna prepublishOnly version npm publish and use the … #11301
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
|
I have another idea, this should probably be generated but not versioned so lerna doesnt complain when this is generated and not commited. What do you think @stocaaro ? |
… the aws-amplify version
|
Per Francisco's comment, the |
cshfang
approved these changes
Apr 28, 2023
elorzafe
reviewed
Apr 28, 2023
| @@ -23,11 +23,12 @@ | |||
| "build:cjs:watch": "node ./build es5 --watch", | |||
| "build:esm:watch": "rimraf lib-esm && node ./build es6 --watch", | |||
| "build": "npm run clean && npm run generate-version && npm run build:esm && npm run build:cjs", | |||
| "generate-version": "genversion src/Platform/version.ts --es6 --semi", | |||
| "generate-version": "genversion src/Platform/version.ts --es6 --semi --source ../aws-amplify", | |||
There was a problem hiding this comment.
Why do you need that --source...?
There was a problem hiding this comment.
This changes the version to be from aws-amplify instead of corresponding to @aws-amplify/core.
4 tasks
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.
Description of changes
The reported version in metrics is currently based on the
@aws-amplify/coreversion when it would be more idiomatic to report on theaws-amplifyversion and the version is trailing by one.This change adds a
prepublishOnlystep to core is run by lerna between updating versioning and pushing the files to npm, then also updates thegenversioncommand to source the version fromaws-amplifyinstead of core.This change also removes the
version.tsfile from core, adding it to.gitignoreto make this a build artifact that isn't checked into git.It is worth noting that this will now also differentiate preid releases, so a version like
5.1.4-unstable.0197e92.5will be published going forward. I have confirmed with product that this is a positive outcome, not a problem to fix.Why this change works
When running
lerna publish, we want to rebuildversion.tsin core after lerna versions all the packages, but before it publishes to NPM.The lerna publish lifecycle scripts give us the opportunity to inject commands at different points in the lerna version and publish process. After versioning and immediately before npm release
prepublishOnlyis run if it exists on any releasable package. By addingprepublishOnlyto@aws-amplify/coreand having it runbuildfor core, this ensures that theversion.tsfile is updated with the currentaws-amplifypackage version.Description of how you validated changes
I have tested the
aws-amplifybased versioning and publishing to verdaccio to test that the build artifacts match the expected values.Checklist
yarn testpassesBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.