Skip to content
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

build: improve cordova-js version ID in built file #230

Merged
merged 1 commit into from
Dec 1, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions build-tools/build-id.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
/*!
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

const fs = require('fs');
const path = require('path');
const execa = require('execa');
const { pkgRoot } = require('./common');

async function getBuildId () {
// Use git describe if in cordova-js repo, else use package version
return fs.existsSync(path.join(pkgRoot, '.git'))
? describeGitRepo()
: require('../package').version;
}

async function describeGitRepo () {
const gitArgs = ['describe', '--always', '--tags', '--match=rel/*', '--dirty'];
return (await execa('git', gitArgs, { cwd: pkgRoot })).stdout;
}

module.exports = getBuildId;
13 changes: 4 additions & 9 deletions build-tools/build.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,26 +17,21 @@
* under the License.
*/

const execa = require('execa');
const bundle = require('./bundle');
const scripts = require('./scripts');
const modules = require('./modules');
const { pkgRoot } = require('./common');
const getBuildId = require('./build-id');

module.exports = function build (userConfig) {
const config = Object.assign({ preprocess: x => x }, userConfig);

return Promise.all([
scripts(config),
modules(config),
getCommitId()
getBuildId()
])
.then(([scripts, modules, commitId]) => {
Object.assign(config, { commitId });
.then(([scripts, modules, buildId]) => {
Object.assign(config, { buildId });
return bundle(scripts, modules, config);
});
};

function getCommitId () {
return execa('git', ['rev-parse', 'HEAD'], { cwd: pkgRoot }).then(data => data.stdout);
}
4 changes: 2 additions & 2 deletions build-tools/bundle.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@ module.exports = function bundle (scripts, modules, config) {
};

const bundleTemplate = ({
commitId,
buildId,
platformName,
platformVersion,
includeScript,
modules
}) => `
// Platform: ${platformName}
// ${commitId}
// cordova-js ${buildId}
/*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
Expand Down