Skip to content

Commit

Permalink
feat(inputs): add semantic_version to specify version range(#3)
Browse files Browse the repository at this point in the history
semantic_version: Specify specifying version range for semantic-release. If no version range is
specified, semantic-release@^15 will be used by default.
  • Loading branch information
cycjimmy committed Oct 31, 2019
1 parent 56fc832 commit 55e8862
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 1 deletion.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ GitHub Action for [Semantic Release](https://github.com/semantic-release/semanti
#### Step3: Add a [Workflow File](https://help.github.com/en/articles/workflow-syntax-for-github-actions) to your repository to create custom automated processes.
* inputs:
* `branch`: [Optional] The branch on which releases should happen. It will override the branch attribute in your configuration file. If the attribute is not configured on both sides, the default is master.
* `semantic_version`: [Optional] Specify specifying version range for semantic-release. If no version range is specified, semantic-release@^15 will be used by default.
* `extra_plugins`: [Optional] Extra plugins for pre-install. You can also specify specifying version range for the extra plugins if you prefer.
* `dry_run`: [Optional] Whether to run semantic release in "dry-run" mode. It will override the dryRun attribute in your configuration file.
* outputs:
Expand Down Expand Up @@ -45,6 +46,7 @@ steps:
id: semantic # Need an `id` for output variables
with:
branch: master
semantic_version: 15.13.28
# You can specify specifying version range for the extra plugins if you prefer.
extra_plugins: |
@semantic-release/git
Expand Down
2 changes: 2 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ branding:
inputs:
branch:
description: 'The branch on which releases should happen. It will override the branch attribute in your configuration file. If the attribute is not configured on both sides, the default is master.'
semantic_version:
description: 'Specify specifying version range for semantic-release. If no version range is specified, semantic-release@^15 will be used by default.'
extra_plugins:
description: 'Extra plugins for pre-install. You can also specify specifying version range for the extra plugins if you prefer.'
dry_run:
Expand Down
4 changes: 3 additions & 1 deletion src/index.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
const core = require('@actions/core');
const semanticRelease = require('semantic-release');
const {handleBranchOption, handleDryRunOption} = require('./handleOptions');
const setUpJob = require('./setUpJob.task');
const installSpecifyingVersionSemantic = require('./installSpecifyingVersionSemantic.task');
const preInstallPlugins = require('./preInstallPlugins.task');
const cleanupNpmrc = require('./cleanupNpmrc.task');
const windUpJob = require('./windUpJob.task');
Expand All @@ -12,8 +12,10 @@ const windUpJob = require('./windUpJob.task');
*/
const release = async () => {
await setUpJob();
await installSpecifyingVersionSemantic();
await preInstallPlugins();

const semanticRelease = require('semantic-release');
const result = await semanticRelease({
...(handleBranchOption()),
...(handleDryRunOption()),
Expand Down
1 change: 1 addition & 0 deletions src/inputs.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"branch": "branch",
"semantic_version": "semantic_version",
"extra_plugins": "extra_plugins",
"dry_run": "dry_run"
}
25 changes: 25 additions & 0 deletions src/installSpecifyingVersionSemantic.task.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
const path = require('path');
const core = require('@actions/core');
const exec = require('./_exec');
const inputs = require('./inputs.json');

/**
* Install Specifying Version semantic-release
* @returns {Promise<void>}
*/
module.exports = async () => {
const semantic_version = core.getInput(inputs.semantic_version);

if (!semantic_version) {
return Promise.resolve();
}

const {stdout, stderr} = await exec(`npm install semantic-release@${semantic_version}`, {
cwd: path.resolve(__dirname)
});
core.debug(stdout);

if (stderr) {
return Promise.reject(stderr);
}
};

0 comments on commit 55e8862

Please sign in to comment.