Skip to content

Commit

Permalink
v1
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul Norton committed Sep 6, 2023
1 parent f2fe9e6 commit eec4717
Show file tree
Hide file tree
Showing 15 changed files with 4,936 additions and 6,651 deletions.
5 changes: 0 additions & 5 deletions .github/codeql/codeql-config.yml

This file was deleted.

4 changes: 2 additions & 2 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ updates:
- package-ecosystem: github-actions
directory: /
schedule:
interval: daily
interval: monthly

- package-ecosystem: npm
directory: /
schedule:
interval: daily
interval: monthly
10 changes: 8 additions & 2 deletions .github/workflows/check-dist.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4

- name: Set Node.js 16.x
uses: actions/setup-node@v3.6.0
uses: actions/setup-node@v3.8.1
with:
node-version: 16.x

Expand All @@ -43,6 +43,12 @@ jobs:
fi
id: diff

- name: Setup go-task
uses: ./.

- name: Test go-task
run: task --version

# If index.js was different than expected, upload the expected version as an artifact
- uses: actions/upload-artifact@v3
if: ${{ failure() && steps.diff.conclusion == 'failure' }}
Expand Down
71 changes: 0 additions & 71 deletions .github/workflows/codeql-analysis.yml

This file was deleted.

25 changes: 0 additions & 25 deletions .github/workflows/test.yml

This file was deleted.

1 change: 0 additions & 1 deletion CODEOWNERS

This file was deleted.

119 changes: 7 additions & 112 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,116 +1,11 @@
# Create a JavaScript Action
# setup-task

<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

## Code in Main

Install the dependencies

```bash
npm install
```

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
Downloads [go-task/task](https://github.com/go-task/task) and installs it to the PATH.

Usage:
```yaml
uses: actions/javascript-action@v1
with:
milliseconds: 1000
- name: Setup go-task
uses: pnorton5432/setup-task@v1
with:
task-version: 3.29.1
```
See the [actions tab](https://github.com/actions/javascript-action/actions) for runs of this action! :rocket:
16 changes: 8 additions & 8 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
name: 'Wait'
description: 'Wait a designated number of milliseconds'
name: 'Setup go-task / task / taskfile'
description: 'Download go-task and add it to PATH'
inputs:
milliseconds: # id of input
description: 'number of milliseconds to wait'
task-version:
description: 'Version of go-task to setup'
required: true
default: '1000'
outputs:
time: # output will be available to future steps
description: 'The current time after waiting'
default: '3.29.1'
branding:
icon: 'terminal'
color: 'blue'
runs:
using: 'node16'
main: 'dist/index.js'
Loading

0 comments on commit eec4717

Please sign in to comment.