feat: Add fallback version
parent
3396dfc432
commit
63d0e46a0b
|
@ -21,6 +21,47 @@ jobs:
|
||||||
with:
|
with:
|
||||||
github-token: ${{ secrets.github_token }}
|
github-token: ${{ secrets.github_token }}
|
||||||
|
|
||||||
|
test-json-new:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
with:
|
||||||
|
path: "./"
|
||||||
|
|
||||||
|
- name: Generate changelog
|
||||||
|
id: changelog
|
||||||
|
uses: ./
|
||||||
|
env:
|
||||||
|
ENV: 'dont-use-git'
|
||||||
|
with:
|
||||||
|
github-token: ${{ secrets.github_token }}
|
||||||
|
version-file: 'test-file-new.json'
|
||||||
|
|
||||||
|
- name: Show file
|
||||||
|
id: show
|
||||||
|
run: |
|
||||||
|
echo "$(<test-file-new.json)"
|
||||||
|
|
||||||
|
test-json-empty:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
with:
|
||||||
|
path: "./"
|
||||||
|
|
||||||
|
- name: Generate changelog
|
||||||
|
id: changelog
|
||||||
|
uses: ./
|
||||||
|
env:
|
||||||
|
ENV: 'dont-use-git'
|
||||||
|
with:
|
||||||
|
github-token: ${{ secrets.github_token }}
|
||||||
|
version-file: './test-file-empty.json'
|
||||||
|
|
||||||
|
- run: echo "$(<./test-file-empty.json)"
|
||||||
|
|
||||||
test-pre-commit:
|
test-pre-commit:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
|
@ -61,6 +102,25 @@ jobs:
|
||||||
github-token: ${{ secrets.github_token }}
|
github-token: ${{ secrets.github_token }}
|
||||||
skip-commit: 'true'
|
skip-commit: 'true'
|
||||||
|
|
||||||
|
test-git-fallback:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
with:
|
||||||
|
path: "./"
|
||||||
|
|
||||||
|
- run: git tag | xargs git tag -d
|
||||||
|
|
||||||
|
- name: Generate changelog
|
||||||
|
id: changelog
|
||||||
|
uses: ./
|
||||||
|
env:
|
||||||
|
ENV: 'dont-use-git'
|
||||||
|
with:
|
||||||
|
github-token: ${{ secrets.github_token }}
|
||||||
|
skip-commit: 'true'
|
||||||
|
|
||||||
test-yaml:
|
test-yaml:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
|
@ -79,6 +139,46 @@ jobs:
|
||||||
version-file: 'test-file.yaml'
|
version-file: 'test-file.yaml'
|
||||||
version-path: 'package.version'
|
version-path: 'package.version'
|
||||||
|
|
||||||
|
test-yaml-new:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
with:
|
||||||
|
path: "./"
|
||||||
|
|
||||||
|
- name: Generate changelog
|
||||||
|
id: changelog
|
||||||
|
uses: ./
|
||||||
|
env:
|
||||||
|
ENV: 'dont-use-git'
|
||||||
|
with:
|
||||||
|
github-token: ${{ secrets.github_token }}
|
||||||
|
version-file: 'test-file-new.yaml'
|
||||||
|
version-path: 'package.version'
|
||||||
|
|
||||||
|
- run: echo "$(<test-file-new.yaml)"
|
||||||
|
|
||||||
|
test-yaml-empty:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
with:
|
||||||
|
path: "./"
|
||||||
|
|
||||||
|
- name: Generate changelog
|
||||||
|
id: changelog
|
||||||
|
uses: ./
|
||||||
|
env:
|
||||||
|
ENV: 'dont-use-git'
|
||||||
|
with:
|
||||||
|
github-token: ${{ secrets.github_token }}
|
||||||
|
version-file: './test-file-empty.yaml'
|
||||||
|
version-path: 'package.version'
|
||||||
|
|
||||||
|
- run: echo "$(<./test-file-empty.yaml)"
|
||||||
|
|
||||||
test-toml:
|
test-toml:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
|
@ -97,6 +197,46 @@ jobs:
|
||||||
version-file: 'test-file.toml'
|
version-file: 'test-file.toml'
|
||||||
version-path: 'package.version'
|
version-path: 'package.version'
|
||||||
|
|
||||||
|
test-toml-new:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
with:
|
||||||
|
path: "./"
|
||||||
|
|
||||||
|
- name: Generate changelog
|
||||||
|
id: changelog
|
||||||
|
uses: ./
|
||||||
|
env:
|
||||||
|
ENV: 'dont-use-git'
|
||||||
|
with:
|
||||||
|
github-token: ${{ secrets.github_token }}
|
||||||
|
version-file: 'test-file-new.toml'
|
||||||
|
version-path: 'package.version'
|
||||||
|
|
||||||
|
- run: echo "$(<test-file-new.toml)"
|
||||||
|
|
||||||
|
test-toml-empty:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
with:
|
||||||
|
path: "./"
|
||||||
|
|
||||||
|
- name: Generate changelog
|
||||||
|
id: changelog
|
||||||
|
uses: ./
|
||||||
|
env:
|
||||||
|
ENV: 'dont-use-git'
|
||||||
|
with:
|
||||||
|
github-token: ${{ secrets.github_token }}
|
||||||
|
version-file: './test/test-file-empty.toml'
|
||||||
|
version-path: 'package.version'
|
||||||
|
|
||||||
|
- run: echo "$(<./test/test-file-empty.toml)"
|
||||||
|
|
||||||
test-multiple-files:
|
test-multiple-files:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
|
|
|
@ -19,6 +19,7 @@ This action will bump version, tag commit and generate a changelog with conventi
|
||||||
- **Optional** `skip-version-file`: Do not update the version file. Default `'false'`.
|
- **Optional** `skip-version-file`: Do not update the version file. Default `'false'`.
|
||||||
- **Optional** `skip-commit`: Do create a release commit. Default `'false'`.
|
- **Optional** `skip-commit`: Do create a release commit. Default `'false'`.
|
||||||
- **Optional** `pre-commit`: Path to the pre-commit script file. No hook by default.
|
- **Optional** `pre-commit`: Path to the pre-commit script file. No hook by default.
|
||||||
|
- **Optional** `fallback-version`: The fallback version, if none is recognized. Default `'0.1.0'`
|
||||||
|
|
||||||
### Pre-Commit hook
|
### Pre-Commit hook
|
||||||
|
|
||||||
|
@ -164,12 +165,18 @@ $ act -j test-json -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s gith
|
||||||
# To run / test git versioning
|
# To run / test git versioning
|
||||||
$ act -j test-git -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token
|
$ act -j test-git -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token
|
||||||
|
|
||||||
|
# To run / test git fallback versioning
|
||||||
|
$ act -j test-git-fallback -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token
|
||||||
|
|
||||||
# To run / test yaml versioning
|
# To run / test yaml versioning
|
||||||
$ act -j test-yaml -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token
|
$ act -j test-yaml -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token
|
||||||
|
|
||||||
# To run / toml git versioning
|
# To run / test toml versioning
|
||||||
$ act -j test-toml -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token
|
$ act -j test-toml -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token
|
||||||
|
|
||||||
|
# To run / test empty / new files test
|
||||||
|
$ act -j test-[json/toml/yaml]-[empty/new] -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token
|
||||||
|
|
||||||
# To run pre-commit test
|
# To run pre-commit test
|
||||||
$ act -j test-pre-commit -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token
|
$ act -j test-pre-commit -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token
|
||||||
|
|
||||||
|
|
|
@ -83,6 +83,11 @@ inputs:
|
||||||
description: 'Path to the pre-commit script file'
|
description: 'Path to the pre-commit script file'
|
||||||
required: false
|
required: false
|
||||||
|
|
||||||
|
fallback-version:
|
||||||
|
description: 'The fallback version, if none is recognized'
|
||||||
|
default: '0.1.0'
|
||||||
|
required: false
|
||||||
|
|
||||||
|
|
||||||
outputs:
|
outputs:
|
||||||
changelog:
|
changelog:
|
||||||
|
|
|
@ -372,6 +372,11 @@
|
||||||
"find-up": "^4.0.0"
|
"find-up": "^4.0.0"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"@iarna/toml": {
|
||||||
|
"version": "2.2.5",
|
||||||
|
"resolved": "https://registry.npmjs.org/@iarna/toml/-/toml-2.2.5.tgz",
|
||||||
|
"integrity": "sha512-trnsAYxU3xnS1gPHPyU961coFyLkh4gAD/0zQ5mymY4yOZ+CYvsPqUbOFSw0aDM4y0tV7tiFxL/1XfXPNC6IPg=="
|
||||||
|
},
|
||||||
"@marionebl/sander": {
|
"@marionebl/sander": {
|
||||||
"version": "0.6.1",
|
"version": "0.6.1",
|
||||||
"resolved": "https://registry.npmjs.org/@marionebl/sander/-/sander-0.6.1.tgz",
|
"resolved": "https://registry.npmjs.org/@marionebl/sander/-/sander-0.6.1.tgz",
|
||||||
|
@ -2238,11 +2243,6 @@
|
||||||
"readable-stream": "2 || 3"
|
"readable-stream": "2 || 3"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"toml": {
|
|
||||||
"version": "3.0.0",
|
|
||||||
"resolved": "https://registry.npmjs.org/toml/-/toml-3.0.0.tgz",
|
|
||||||
"integrity": "sha512-y/mWCZinnvxjTKYhJ+pYxwD0mRLVvOtdS2Awbgxln6iEnt4rk0yBxeSBHkGJcPucRiG0e55mwWp+g/05rsrd6w=="
|
|
||||||
},
|
|
||||||
"trim-newlines": {
|
"trim-newlines": {
|
||||||
"version": "3.0.0",
|
"version": "3.0.0",
|
||||||
"resolved": "https://registry.npmjs.org/trim-newlines/-/trim-newlines-3.0.0.tgz",
|
"resolved": "https://registry.npmjs.org/trim-newlines/-/trim-newlines-3.0.0.tgz",
|
||||||
|
|
|
@ -26,11 +26,11 @@
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@actions/core": "1.2.4",
|
"@actions/core": "1.2.4",
|
||||||
"@actions/exec": "1.0.4",
|
"@actions/exec": "1.0.4",
|
||||||
|
"@iarna/toml": "^2.2.5",
|
||||||
"conventional-changelog": "3.1.21",
|
"conventional-changelog": "3.1.21",
|
||||||
"conventional-recommended-bump": "6.0.9",
|
"conventional-recommended-bump": "6.0.9",
|
||||||
"git-semver-tags": "4.0.0",
|
"git-semver-tags": "4.0.0",
|
||||||
"object-path": "^0.11.4",
|
"object-path": "^0.11.4",
|
||||||
"toml": "^3.0.0",
|
|
||||||
"yaml": "^1.10.0"
|
"yaml": "^1.10.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
|
|
|
@ -1,3 +1,6 @@
|
||||||
|
const core = require('@actions/core')
|
||||||
|
const semverValid = require('semver').valid
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Bumps the given version with the given release type
|
* Bumps the given version with the given release type
|
||||||
*
|
*
|
||||||
|
@ -6,22 +9,37 @@
|
||||||
* @returns {string}
|
* @returns {string}
|
||||||
*/
|
*/
|
||||||
module.exports = (releaseType, version) => {
|
module.exports = (releaseType, version) => {
|
||||||
let [major, minor, patch] = version.split('.')
|
let major, minor, patch
|
||||||
|
|
||||||
switch (releaseType) {
|
if (version) {
|
||||||
case 'major':
|
[major, minor, patch] = version.split('.')
|
||||||
major = parseInt(major, 10) + 1
|
|
||||||
minor = 0
|
switch (releaseType) {
|
||||||
|
case 'major':
|
||||||
|
major = parseInt(major, 10) + 1
|
||||||
|
minor = 0
|
||||||
|
patch = 0
|
||||||
|
break
|
||||||
|
|
||||||
|
case 'minor':
|
||||||
|
minor = parseInt(minor, 10) + 1
|
||||||
|
patch = 0
|
||||||
|
break
|
||||||
|
|
||||||
|
default:
|
||||||
|
patch = parseInt(patch, 10) + 1
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
let version = semverValid(core.getInput('fallback-version'))
|
||||||
|
|
||||||
|
if (version) {
|
||||||
|
[major, minor, patch] = version.split('.')
|
||||||
|
} else {
|
||||||
|
// default
|
||||||
|
major = 0
|
||||||
|
minor = 1
|
||||||
patch = 0
|
patch = 0
|
||||||
break
|
}
|
||||||
|
|
||||||
case 'minor':
|
|
||||||
minor = parseInt(minor, 10) + 1
|
|
||||||
patch = 0
|
|
||||||
break
|
|
||||||
|
|
||||||
default:
|
|
||||||
patch = parseInt(patch, 10) + 1
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return `${major}.${minor}.${patch}`
|
return `${major}.${minor}.${patch}`
|
||||||
|
|
|
@ -25,7 +25,9 @@ module.exports = class BaseVersioning {
|
||||||
* @return {string}
|
* @return {string}
|
||||||
*/
|
*/
|
||||||
read = () => {
|
read = () => {
|
||||||
return fs.readFileSync(this.fileLocation, 'utf8')
|
if (fs.existsSync(this.fileLocation)) {
|
||||||
|
return fs.readFileSync(this.fileLocation, 'utf8')
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
@ -13,7 +13,7 @@ module.exports = new (class Git extends BaseVersioning {
|
||||||
gitSemverTags({
|
gitSemverTags({
|
||||||
tagPrefix,
|
tagPrefix,
|
||||||
}, (err, tags) => {
|
}, (err, tags) => {
|
||||||
const currentVersion = tags.shift().replace(tagPrefix, '')
|
const currentVersion = tags.length > 0 ? tags.shift().replace(tagPrefix, '') : null
|
||||||
|
|
||||||
// Get the new version
|
// Get the new version
|
||||||
this.newVersion = bumpVersion(
|
this.newVersion = bumpVersion(
|
||||||
|
|
|
@ -12,10 +12,15 @@ module.exports = new (class Json extends BaseVersioning {
|
||||||
* @return {*}
|
* @return {*}
|
||||||
*/
|
*/
|
||||||
bump = (releaseType) => {
|
bump = (releaseType) => {
|
||||||
|
let jsonContent = {}
|
||||||
|
let oldVersion
|
||||||
|
|
||||||
// Read the file
|
// Read the file
|
||||||
const fileContent = this.read()
|
const fileContent = this.read()
|
||||||
const jsonContent = JSON.parse(fileContent)
|
if (fileContent) {
|
||||||
const oldVersion = objectPath.get(jsonContent, this.versionPath)
|
jsonContent = JSON.parse(fileContent)
|
||||||
|
oldVersion = objectPath.get(jsonContent, this.versionPath)
|
||||||
|
}
|
||||||
|
|
||||||
// Get the new version
|
// Get the new version
|
||||||
this.newVersion = bumpVersion(
|
this.newVersion = bumpVersion(
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
const objectPath = require('object-path')
|
const objectPath = require('object-path')
|
||||||
const toml = require('toml')
|
const toml = require('@iarna/toml')
|
||||||
|
|
||||||
const BaseVersioning = require('./base')
|
const BaseVersioning = require('./base')
|
||||||
const bumpVersion = require('../helpers/bumpVersion')
|
const bumpVersion = require('../helpers/bumpVersion')
|
||||||
|
@ -13,10 +13,15 @@ module.exports = new (class Toml extends BaseVersioning{
|
||||||
* @return {*}
|
* @return {*}
|
||||||
*/
|
*/
|
||||||
bump = (releaseType) => {
|
bump = (releaseType) => {
|
||||||
|
let tomlContent = {}
|
||||||
|
let oldVersion
|
||||||
|
|
||||||
// Read the file
|
// Read the file
|
||||||
const fileContent = this.read()
|
const fileContent = this.read()
|
||||||
const tomlContent = toml.parse(fileContent)
|
if (fileContent) {
|
||||||
const oldVersion = objectPath.get(tomlContent, this.versionPath)
|
tomlContent = toml.parse(fileContent)
|
||||||
|
oldVersion = objectPath.get(tomlContent, this.versionPath)
|
||||||
|
}
|
||||||
|
|
||||||
// Get the new version
|
// Get the new version
|
||||||
this.newVersion = bumpVersion(
|
this.newVersion = bumpVersion(
|
||||||
|
@ -28,13 +33,19 @@ module.exports = new (class Toml extends BaseVersioning{
|
||||||
const versionName = this.versionPath.split('.').pop()
|
const versionName = this.versionPath.split('.').pop()
|
||||||
|
|
||||||
// Update the file
|
// Update the file
|
||||||
this.update(
|
if (fileContent) {
|
||||||
// We use replace so we can preserve white spaces and comments
|
this.update(
|
||||||
fileContent.replace(
|
// We use replace instead of yaml.stringify so we can preserve white spaces and comments
|
||||||
`${versionName} = "${oldVersion}"`,
|
fileContent.replace(
|
||||||
`${versionName} = "${this.newVersion}"`,
|
`${versionName} = "${oldVersion}"`,
|
||||||
),
|
`${versionName} = "${this.newVersion}"`,
|
||||||
)
|
),
|
||||||
|
)
|
||||||
|
} else {
|
||||||
|
// Update the content with the new version
|
||||||
|
objectPath.set(tomlContent, this.versionPath, this.newVersion)
|
||||||
|
this.update(toml.stringify(tomlContent))
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
})
|
})
|
||||||
|
|
|
@ -13,10 +13,15 @@ module.exports = new (class Yaml extends BaseVersioning{
|
||||||
* @return {*}
|
* @return {*}
|
||||||
*/
|
*/
|
||||||
bump = (releaseType) => {
|
bump = (releaseType) => {
|
||||||
|
let yamlContent = {}
|
||||||
|
let oldVersion
|
||||||
|
|
||||||
// Read the file
|
// Read the file
|
||||||
const fileContent = this.read()
|
const fileContent = this.read()
|
||||||
const yamlContent = yaml.parse(fileContent)
|
if (fileContent) {
|
||||||
const oldVersion = objectPath.get(yamlContent, this.versionPath)
|
yamlContent = yaml.parse(fileContent)
|
||||||
|
oldVersion = objectPath.get(yamlContent, this.versionPath)
|
||||||
|
}
|
||||||
|
|
||||||
// Get the new version
|
// Get the new version
|
||||||
this.newVersion = bumpVersion(
|
this.newVersion = bumpVersion(
|
||||||
|
@ -28,13 +33,19 @@ module.exports = new (class Yaml extends BaseVersioning{
|
||||||
const versionName = this.versionPath.split('.').pop()
|
const versionName = this.versionPath.split('.').pop()
|
||||||
|
|
||||||
// Update the file
|
// Update the file
|
||||||
this.update(
|
if (fileContent) {
|
||||||
// We use replace instead of yaml.stringify so we can preserve white spaces and comments
|
this.update(
|
||||||
fileContent.replace(
|
// We use replace instead of yaml.stringify so we can preserve white spaces and comments
|
||||||
`${versionName}: '${oldVersion}'`,
|
fileContent.replace(
|
||||||
`${versionName}: '${this.newVersion}'`,
|
`${versionName}: '${oldVersion}'`,
|
||||||
),
|
`${versionName}: '${this.newVersion}'`,
|
||||||
)
|
),
|
||||||
|
)
|
||||||
|
} else {
|
||||||
|
// Update the content with the new version
|
||||||
|
objectPath.set(yamlContent, this.versionPath, this.newVersion)
|
||||||
|
this.update(yaml.stringify(yamlContent))
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
})
|
})
|
||||||
|
|
Loading…
Reference in New Issue