Skip to content

Commit

Permalink
create-release-action
Browse files Browse the repository at this point in the history
  • Loading branch information
yseto committed Feb 4, 2021
1 parent e7bcecd commit 0bff225
Show file tree
Hide file tree
Showing 13 changed files with 6,539 additions and 4,110 deletions.
15 changes: 14 additions & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ on:
branches:
- main
- 'releases/*'
tags:
- v*

jobs:
# unit tests
Expand All @@ -20,6 +22,17 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2

- run: |
mkdir -p artifacts/1/2/
echo 1 > artifacts/1.txt
echo 2 > artifacts/1/2.txt
echo 3 > artifacts/1/2/3.txt
- uses: ./
if: startsWith(github.ref, 'refs/tags/v')
with:
milliseconds: 1000
directory: artifacts/
github-token: ${{ secrets.GITHUB_TOKEN }}
tag-prefix: 'refs/tags/v'
bump-up-branch-prefix: 'bump-version-'
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -65,3 +65,5 @@ typings/

# next.js build output
.next

tmp-readdir/
100 changes: 7 additions & 93 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,6 @@
# Create a JavaScript Action
# create-release-action

<p align="center">
<a href="https://github.com/actions/javascript-action/actions"><img alt="javscript-action status" src="https://github.com/actions/javascript-action/workflows/units-test/badge.svg"></a>
</p>

Use this template to bootstrap the creation of a JavaScript action.:rocket:

This template includes tests, linting, a validation workflow, publishing, and versioning guidance.

If you are new, there's also a simpler introduction. See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)

## Create an action from this template

Click the `Use this Template` and provide the new repo details for your action
<a href="https://github.com/yseto/create-release-action/actions"><img alt="javscript-action status" src="https://github.com/yseto/create-release-action/workflows/units-test/badge.svg"></a>

## Code in Main

Expand All @@ -26,91 +14,17 @@ Run the tests :heavy_check_mark:

```bash
$ npm test

PASS ./index.test.js
✓ throws invalid number (3ms)
wait 500 ms (504ms)
test runs (95ms)
...
```

## Change action.yml

The action.yml defines the inputs and output for your action.

Update the action.yml with your name, description, inputs and outputs for your action.

See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions)

## Change the Code

Most toolkit and CI/CD operations involve async operations so the action is run in an async function.

```javascript
const core = require('@actions/core');
...

async function run() {
try {
...
}
catch (error) {
core.setFailed(error.message);
}
}

run()
```

See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages.

## Package for distribution

GitHub Actions will run the entry point from the action.yml. Packaging assembles the code into one file that can be checked in to Git, enabling fast and reliable execution and preventing the need to check in node_modules.

Actions are run from GitHub repos. Packaging the action will create a packaged action in the dist folder.

Run prepare

```bash
npm run prepare
```

Since the packaged index.js is run from the dist folder.

```bash
git add dist
```

## Create a release branch

Users shouldn't consume the action from master since that would be latest code and actions can break compatibility between major versions.

Checkin to the v1 release branch

```bash
git checkout -b v1
git commit -a -m "v1 release"
```

```bash
git push origin v1
```

Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project.

Your action is now published! :rocket:

See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)

## Usage

You can now consume the action by referencing the v1 branch

```yaml
uses: actions/javascript-action@v1
uses: yseto/create-release-action@main
with:
milliseconds: 1000
directory: artifacts/
github-token: ${{ secrets.GITHUB_TOKEN }}
tag-prefix: 'refs/tags/v'
bump-up-branch-prefix: 'bump-version-'
```
See the [actions tab](https://github.com/actions/javascript-action/actions) for runs of this action! :rocket:
23 changes: 15 additions & 8 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,20 @@
name: 'Wait'
description: 'Wait a designated number of milliseconds'
name: 'create-release-action'
description: 'create release'
inputs:
milliseconds: # id of input
description: 'number of milliseconds to wait'
github-token:
description: 'github-token'
required: true
default: '1000'
outputs:
time: # output will be available to future steps
description: 'The message to output'
directory:
description: 'directory containing artifacts'
required: true
tag-prefix:
description: 'tag name prefix'
required: true
default: 'refs/tags/v'
bump-up-branch-prefix:
description: 'bump up branch name prefix'
required: true
default: 'bump-version-'
runs:
using: 'node12'
main: 'dist/index.js'
Loading

0 comments on commit 0bff225

Please sign in to comment.