diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index d313453..0b47495 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,6 +1,6 @@ # These are supported funding model platforms -github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] +github: coreybutler patreon: coreybutler open_collective: # Replace with a single Open Collective username ko_fi: # Replace with a single Ko-fi username diff --git a/README.md b/README.md index 6026da9..8cdae73 100644 --- a/README.md +++ b/README.md @@ -2,24 +2,31 @@ This action will read a `package.json` file and compare the `version` attribute to the project's known tags. If a corresponding tag does not exist, it will be created. +This tag works well in combination with: + +- [actions/create-release](https://github.com/actions/create-release) (Auto-release) +- [author/action-publish](https://github.com/author/action-publish) (Auto-publish JavaScript/Node modules) +- [author/action-rollback](https://github.com/author/action-rollback) (Auto-rollback releases on failures) +- [author/template-cross-runtime](https://github.com/author/template-cross-runtime) (a cross-runtime JavaScript repo template) + ## Usage -The following is an example `.github/main.workflow` that will execute when a `push` to the `master` branch occurs. +The following is an example `.github/workflows/main.yml` that will execute when a `push` to the `master` branch occurs. ```yaml -name: My Workflow +name: Create Tag -on: +on: push: branches: - - master + - master jobs: build: runs-on: ubuntu-latest steps: - - uses: actions/checkout@master - - uses: butlerlogic/action-autotag@1.0.0 + - uses: actions/checkout@v2 + - uses: butlerlogic/action-autotag@stable with: GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" ``` @@ -29,8 +36,8 @@ To make this work, the workflow must have the checkout action _before_ the autot This **order** is important! ```yaml -- uses: actions/checkout@master -- uses: butlerlogic/action-autotag@1.0.0 +- uses: actions/checkout@v2 +- uses: butlerlogic/action-autotag@stable ``` > If the repository is not checked out first, the autotagger cannot find the package.json file. @@ -40,55 +47,55 @@ This **order** is important! The `GITHUB_TOKEN` must be passed in. Without this, it is not possible to create a new tag. Make sure the autotag action looks like the following example: ```yaml -- uses: butlerlogic/action-autotag@1.0.0 +- uses: butlerlogic/action-autotag@stable with: GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" ``` -The action will automatically extract the token at runtime. **DO NOT MANUALLY ENTER YOUR TOKEN.** If you put the actual token in your workflow file, you're make it accessible in plaintext to anyone who ever views the repository (it wil be in your git history). +The action will automatically extract the token at runtime. **DO NOT MANUALLY ENTER YOUR TOKEN.** If you put the actual token in your workflow file, you'll make it accessible (in plaintext) to anyone who ever views the repository (it will be in your git history). ### Optional Configurations There are several options to customize how the tag is created. 1. `package_root` - - By default, autotag will look for the `package.json` file in the project root. If the file is located in a subdirectory, this option an be used to point to the correct file. - + + By default, autotag will look for the `package.json` file in the project root. If the file is located in a subdirectory, this option can be used to point to the correct file. + ```yaml - uses: butlerlogic/action-autotag@1.0.0 with: GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" package_root: "/path/to/subdirectory" ``` - -1. `tag_prefx` - - By default, `package.json` uses [semantic versioning](https://semver.org/), such as `1.0.0`. A prefix can be used to add text before the tag name. For example, if `tag_prefx` is set to `v`, then the tag would be labeled as `v1.0.0`. - + +1. `tag_prefix` + + By default, `package.json` uses [semantic versioning](https://semver.org/), such as `1.0.0`. A prefix can be used to add text before the tag name. For example, if `tag_prefix` is set to `v`, then the tag would be labeled as `v1.0.0`. + ```yaml - uses: butlerlogic/action-autotag@1.0.0 with: GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" - tag_prefx: "v" + tag_prefix: "v" ``` - + 1. `tag_suffix` - + Text can also be applied to the end of the tag by setting `tag_suffix`. For example, if `tag_suffix` is ` (beta)`, the tag would be `1.0.0 (beta)`. Please note this example violates semantic versioning and is merely here to illustrate how to add text to the end of a tag name if you _really_ want to. - + ```yaml - uses: butlerlogic/action-autotag@1.0.0 with: GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" tag_suffix: " (beta)" ``` - + 1. `tag_message` - + This is the annotated commit message associated with the tag. By default, a - changelog will be generated from the commits between the latest tag and the new tag (HEAD). This will override that with a hard-coded message. - + changelog will be generated from the commits between the latest tag and the new tag (HEAD). Setting this option will override it witha custom message. + ```yaml - uses: butlerlogic/action-autotag@1.0.0 with: @@ -96,6 +103,18 @@ There are several options to customize how the tag is created. tag_message: "Custom message goes here." ``` +1. `version` + + Explicitly set the version instead of automatically detecting from `package.json`. + Useful for non-JavaScript projects where version may be output by a previous action. + + ```yaml + - uses: butlerlogic/action-autotag@1.0.0 + with: + GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" + version: "${{ steps.previous_step.outputs.version }}" + ``` + ## Developer Notes If you are building an action that runs after this one, be aware this action produces several [outputs](https://help.github.com/en/articles/metadata-syntax-for-github-actions#outputs): diff --git a/action.yml b/action.yml index 1e02d11..5b11a2c 100644 --- a/action.yml +++ b/action.yml @@ -1,15 +1,15 @@ -name: 'Autotagger' -description: 'Automatically generate new tags when the package.json version changes.' -author: 'ButlerLogic' +name: "Autotagger" +description: "Automatically generate new tags when the package.json version changes." +author: "ButlerLogic" branding: - icon: 'tag' - color: 'black' + icon: "tag" + color: "black" inputs: package_root: description: Autotag will look for the package.json file in in this location. required: false default: './' - tag_prefx: + tag_prefix: description: By default, package.json uses semantic versioning, such as "1.0.0". A prefix can be used to add text before the tag name. For example, if tag_prefx is set to "v", then the tag would be labeled as "v1.0.0". required: false tag_suffix: @@ -18,6 +18,9 @@ inputs: tag_message: description: This is the annotated commit message associated with the tag. By default, a changelog will be generated from the commits between the latest tag and the new tag (HEAD). This will override that with a hard-coded message. required: false + version: + description: Explicitly set the version here instead of automatically detecting from `package.json`. Useful for non-JavaScript projects where version may be output by a previous action. + required: false outputs: tagname: description: Returns the new tag value. Empty if a tag is not created. @@ -28,7 +31,7 @@ outputs: tagmessage: description: The messge applied to the tag reference (this is what shows up on the tag screen on Github). version: - description: The version, as defined in package.json. + description: The version, as defined in package.json or explicitly set in the input. runs: - using: 'node12' - main: 'lib/main.js' + using: "node12" + main: "lib/main.js" diff --git a/lib/main.js b/lib/main.js index 9742cae..b08b9f1 100644 --- a/lib/main.js +++ b/lib/main.js @@ -1,32 +1,68 @@ -// import * as core from '@actions/core'; const github = require('@actions/github') const core = require('@actions/core') const fs = require('fs') const path = require('path') +const os = require('os') async function run() { try { - core.debug(` Available environment variables:\n -> ${Object.keys(process.env).map(i => i + ' :: ' + process.env[i]).join('\n -> ')}`) + const { repo } = github.context - let dir = fs.readdirSync(path.resolve(process.env.GITHUB_WORKSPACE), { withFileTypes: true }).map(entry => { - return `${entry.isDirectory() ? '> ' : ' - '}${entry.name}` - }).join('\n') + core.debug( + ` Available environment variables:\n -> ${Object.keys(process.env) + .map(i => i + ' :: ' + process.env[i]) + .join('\n -> ')}` + ) + + const dir = fs + .readdirSync(path.resolve(process.env.GITHUB_WORKSPACE), { withFileTypes: true }) + .map(entry => { + return `${entry.isDirectory() ? '> ' : ' - '}${entry.name}` + }) + .join('\n') core.debug(` Working Directory: ${process.env.GITHUB_WORKSPACE}:\n${dir}`) - - const pkg_root = core.getInput('package_root', { required: false }) - let pkgfile = path.join(process.env.GITHUB_WORKSPACE, pkg_root, 'package.json') + const pkg_root = core.getInput('package_root', { required: false }) + const pkgfile = path.join(process.env.GITHUB_WORKSPACE, pkg_root, 'package.json') if (!fs.existsSync(pkgfile)) { core.setFailed('package.json does not exist.') return } - let pkg = require(pkgfile) - + const pkg = require(pkgfile) core.setOutput('version', pkg.version) core.debug(` Detected version ${pkg.version}`) +// core.debug(` Available environment variables:\n -> ${Object.keys(process.env).map(i => i + ' :: ' + process.env[i]).join('\n -> ')}`) + +// let version = "" + +// if (!process.env.hasOwnProperty('INPUT_VERSION') || process.env.INPUT_VERSION.trim().length === 0) { +// let dir = fs.readdirSync(path.resolve(process.env.GITHUB_WORKSPACE), { withFileTypes: true }).map(entry => { +// return `${entry.isDirectory() ? '> ' : ' - '}${entry.name}` +// }).join('\n') + +// core.debug(` Working Directory: ${process.env.GITHUB_WORKSPACE}:\n${dir}`) + +// const pkg_root = core.getInput('package_root', { required: false }) +// let pkgfile = path.join(process.env.GITHUB_WORKSPACE, pkg_root, 'package.json') + +// if (!fs.existsSync(pkgfile)) { +// core.setFailed('package.json does not exist.') +// return +// } + +// let pkg = require(pkgfile) +// version = pkg.version +// } else { +// version = process.env.INPUT_VERSION.trim() +// } + +// core.setOutput('version', version) +// core.debug(` Detected version ${version}`) + + if (!process.env.hasOwnProperty('INPUT_GITHUB_TOKEN') || process.env.INPUT_GITHUB_TOKEN.trim().length === 0) { if (!process.env.hasOwnProperty('GITHUB_TOKEN')) { core.setFailed('Invalid or missing GITHUB_TOKEN.') @@ -42,88 +78,94 @@ async function run() { let tags try { tags = await git.repos.listTags({ - owner, - repo, - per_page: 100 + ...repo, + per_page: 100, }) } catch (e) { - tags = {} + tags = { + data: [], + } + } + + const getTagName = version => { + const tagPrefix = core.getInput('tag_prefix', { required: false }) + const tagSuffix = core.getInput('tag_suffix', { required: false }) + return `${tagPrefix}${version}${tagSuffix}` } // Check for existance of tag and abort (short circuit) if it already exists. for (let tag of tags.data) { - if (tag.name.trim().toLowerCase() === pkg.version.trim().toLowerCase()) { - core.warning(`"${tag.name.trim()}" tag already exists.`) + if (tag.name === getTagName(pkg.version)) { + console.log(`"${tag.name.trim()}" tag already exists.` + os.EOL) core.setOutput('tagname', '') return } } // Create the new tag name - let tagName = pkg.version - const tagPrefix = core.getInput('tag_prefix', { required: false }) - const tagSuffix = core.getInput('tag_suffix', { required: false }) + const tagName = getTagName(pkg.version) + let tagMsg = core.getInput('tag_message', { required: false }).trim() - - tagName = `${tagPrefix}${tagName}${tagSuffix}` - if (tagMsg.length === 0 && tags.data.length > 0) { try { latestTag = tags.data.shift() let changelog = await git.repos.compareCommits({ - owner, - repo, + ...repo, base: latestTag.name, - head: 'master' + head: 'master', }) - tagMsg = changelog.data.commits.map(commit => `**1) ${commit.commit.message}**${commit.hasOwnProperty('author') ? (commit.author.hasOwnProperty('login') ? ' (' + commit.author.login + ')' : '') : ''}\n(SHA: ${commit.sha})\n`).join('\n') + tagMsg = changelog.data.commits + .map( + commit => + `**1) ${commit.commit.message}**${ + commit.hasOwnProperty('author') + ? commit.author.hasOwnProperty('login') + ? ' (' + commit.author.login + ')' + : '' + : '' + }\n(SHA: ${commit.sha})\n` + ) + .join('\n') } catch (e) { - core.setFailed(e.message) - return + console.log('Failed to generate changelog from commits: ' + e.message + os.EOL) + tagMsg = tagName } } let newTag - try { - tagMsg = tagMsg.trim().length > 0 - ? tagMsg - : `Version ${pkg.version}` + tagMsg = tagMsg.trim().length > 0 ? tagMsg : `Version ${pkg.version}` newTag = await git.git.createTag({ - owner, - repo, + ...repo, tag: tagName, message: tagMsg, object: process.env.GITHUB_SHA, - type: 'commit' + type: 'commit', }) - core.warning(`Created new tag: ${newTag.data.tag}`) + console.log(`Created new tag: ${newTag.data.tag}` + os.EOL) } catch (e) { core.setFailed(e.message) return } let newReference - try { newReference = await git.git.createRef({ - owner, - repo, + ...repo, ref: `refs/tags/${newTag.data.tag}`, - sha: newTag.data.sha + sha: newTag.data.sha, }) - core.warning(`Reference ${newReference.data.ref} available at ${newReference.data.url}`) + console.log(`Reference ${newReference.data.ref} available at ${newReference.data.url}` + os.EOL) } catch (e) { core.warning({ - owner, - repo, + ...repo, ref: `refs/tags/${newTag.data.tag}`, - sha: newTag.data.sha + sha: newTag.data.sha, }) core.setFailed(e.message) @@ -136,6 +178,7 @@ async function run() { core.setOutput('tagsha', newTag.data.sha) core.setOutput('taguri', newReference.data.url) core.setOutput('tagmessage', tagMsg.trim()) + core.setOutput('tagref', newReference.data.ref) } } catch (error) { core.warning(error.message) @@ -143,6 +186,7 @@ async function run() { core.setOutput('tagsha', '') core.setOutput('taguri', '') core.setOutput('tagmessage', '') + core.setOutput('tagref', '') } } diff --git a/package.json b/package.json index 65e7f44..93159b1 100644 --- a/package.json +++ b/package.json @@ -16,11 +16,10 @@ "node", "setup" ], - "type": "module", "author": "ButlerLogic", "license": "MIT", "dependencies": { - "@actions/core": "^1.0.0", - "@actions/github": "^1.0.0" + "@actions/core": "^1.2.2", + "@actions/github": "^2.1.0" } }