-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
Call version lifecycle scripts during publish #1029
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -536,12 +536,26 @@ export default class PublishCommand extends Command { | |
this.updatePackageDepsObject(pkg, "devDependencies", exact); | ||
this.updatePackageDepsObject(pkg, "peerDependencies", exact); | ||
|
||
// exec preversion script | ||
pkg.runScript("preversion", (err) => { | ||
if (err) { | ||
this.logger.error("publish", "error running preversion", pkg.name, err); | ||
} | ||
}); | ||
|
||
// write new package | ||
writePkg.sync(packageJsonLocation, pkg.toJSON()); | ||
// NOTE: Object.prototype.toJSON() is normally called when passed to | ||
// JSON.stringify(), but write-pkg iterates Object.keys() before serializing | ||
// so it has to be explicit here (otherwise it mangles the instance properties) | ||
|
||
// exec version script | ||
pkg.runScript("version", (err) => { | ||
if (err) { | ||
this.logger.error("publish", "error running version", pkg.name, err); | ||
} | ||
}); | ||
|
||
// we can now generate the Changelog, based on the | ||
// the updated version that we're about to release. | ||
if (this.options.conventionalCommits) { | ||
|
@@ -595,7 +609,7 @@ export default class PublishCommand extends Command { | |
} | ||
|
||
gitCommitAndTagVersionForUpdates() { | ||
const tags = this.updates.map(({ package: { name } }) => | ||
const tags = this.updates.map(({ "package": { name } }) => | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I can back out this change, but package is a reserved keyword and shouldn't be referenced without quotes. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Indeed, good call! |
||
`${name}@${this.updatesVersions[name]}` | ||
); | ||
const subject = this.options.message || "Publish"; | ||
|
@@ -604,6 +618,15 @@ export default class PublishCommand extends Command { | |
GitUtilities.commit(message, this.execOpts); | ||
tags.forEach((tag) => GitUtilities.addTag(tag, this.execOpts)); | ||
|
||
// run the postversion script for each update | ||
this.updates.forEach(({ "package": pkg }) => { | ||
pkg.runScript("postversion", (err) => { | ||
if (err) { | ||
this.logger.error("publish", "error running postversion", pkg.name, err); | ||
} | ||
}); | ||
}); | ||
|
||
return tags; | ||
} | ||
|
||
|
@@ -614,6 +637,15 @@ export default class PublishCommand extends Command { | |
GitUtilities.commit(message, this.execOpts); | ||
GitUtilities.addTag(tag, this.execOpts); | ||
|
||
// run the postversion script for each update | ||
this.updates.forEach(({ "package": pkg }) => { | ||
pkg.runScript("postversion", (err) => { | ||
if (err) { | ||
this.logger.error("publish", "error running postversion", pkg.name, err); | ||
} | ||
}); | ||
}); | ||
|
||
return tag; | ||
} | ||
|
||
|
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"lerna": "__TEST_VERSION__", | ||
"version": "1.0.0" | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"name": "lifecycle" | ||
} |
13 changes: 13 additions & 0 deletions
13
test/fixtures/PublishCommand/lifecycle/packages/package-1/package.json
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
{ | ||
"name": "package-1", | ||
"version": "1.0.0", | ||
"scripts": { | ||
"preversion": "exit 0", | ||
"version": "exit 0", | ||
"postversion": "exit 0", | ||
"prepublishOnly": "exit 0", | ||
"prepublish": "exit 0", | ||
"publish": "exit 0", | ||
"postpublish": "exit 0" | ||
} | ||
} |
7 changes: 7 additions & 0 deletions
7
test/fixtures/PublishCommand/lifecycle/packages/package-2/package.json
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{ | ||
"name": "package-2", | ||
"version": "1.0.0", | ||
"dependencies": { | ||
"package-1": "^1.0.0" | ||
} | ||
} |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will run script asynchronously, wouldn't it? Same goes for other hooks that were added.
Are we fine with that?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That’s true. I forgot that almost everything in publish is synchronous, unlike bootstrap where parallelism is important.