[kbn-pm] Enable intermediate build directory for projects #16839
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
kimjoar
added
Team:Core
kimjoar
force-pushed
the
platform/intermediate-build-directory
branch
from
fde6768 to
98c1495
Compare
kimjoar
commented
Feb 21, 2018
| @@ -7,7 +7,7 @@ export type PackageDependencies = { [key: string]: string }; | |||
| export type PackageScripts = { [key: string]: string }; | |||
|
|
|||
| export function readPackageJson(dir: string) { | |||
| return readPkg(path.join(dir, 'package.json'), { normalize: false }); | |||
There was a problem hiding this comment.
Removed this, as it's already handled by readPkg
💚 Build Succeeded |
azasypkin
approved these changes
Feb 21, 2018
| parents: true, | ||
| nodir: true, | ||
| dot: true, | ||
| }); | ||
|
|
||
| const packageJson = project.json; | ||
| // When a project is using an intermediate build directory, they might copy | ||
| // the `package.json` into that directory. If so, we want to use that as the |
There was a problem hiding this comment.
nit: maybe make it clear that projects not only can copy package.json (that's not a problem per se), but rather put a modified version of package.json into that directory that we'd like to rely on?
| @@ -38,7 +39,15 @@ describe('kbn-pm production', function() { | |||
| }); | |||
|
|
|||
| expect(files.sort()).toMatchSnapshot(); | |||
|
|
|||
| for (const file of files) { | |||
There was a problem hiding this comment.
nit: Maybe we can get rid of "conditional" expect and do something like this instead?
const packageFilePromises = files
.filter(file => file.endsWith('package.json'))
.map(packageFile => readPackageJson(join(buildRoot, packageFile)));
expect(await Promise.all(packageFilePromises)).toMatchSnapshot();There was a problem hiding this comment.
As the snapshots already account for the expect not running (aka it handles the snapshot count), I think I'll keep this as-is for now.
kimjoar
force-pushed
the
platform/intermediate-build-directory
branch
from
1d8a4ba to
b19c0b0
Compare
azasypkin
reviewed
Feb 21, 2018
| @@ -77,6 +77,17 @@ async function buildProject(project: Project) { | |||
| } | |||
| } | |||
|
|
|||
| /** | |||
| * Copy the all the project's files from it's "intermediate build directory" and | |||
There was a problem hiding this comment.
typo: Copy the all the --> Copy all the?
typo: from it's --> from its?
💚 Build Succeeded |
kimjoar
added a commit
that referenced
this pull request
Feb 21, 2018
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.
Replaces #16815.
Introduces the option of having an intermediate build directory for projects.
This extends
@kbn/pmto better support build steps like Kibana's and the build step provided by the plugin helpers. First, it adds support for thekibana.build.intermediateBuildDirectoryconfig in package.json that can define an alternate directory to use for the source of the built package. Next, rather than relying on the cachedpacakge.jsonwhen writing the production package,package.jsonis read from the build output and falls back to the cached value. This allows packages to modify their package.json in their build step and not have those changes discarded.