Skip to content

Commit

Permalink
Release the beast 😈
Browse files Browse the repository at this point in the history
  • Loading branch information
stanleynguyen committed Aug 15, 2020
1 parent fe2a26d commit 8a716c5
Show file tree
Hide file tree
Showing 11 changed files with 6,563 additions and 5,316 deletions.
17 changes: 4 additions & 13 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: "units-test"
name: 'test'
on:
pull_request:
push:
Expand All @@ -8,18 +8,9 @@ on:

jobs:
# unit tests
units:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- run: npm ci
- run: npm test

# test action works running from the graph
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: ./
with:
milliseconds: 1000
- uses: actions/checkout@v2
- run: npm ci
- run: npm run all
34 changes: 13 additions & 21 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,21 +1,13 @@
MIT License

Copyright (c) 2019 GitHub Actions

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
Version 2, December 2004

Copyright (C) 2020 Stanley Nguyen <[email protected]>

Everyone is permitted to copy and distribute verbatim or modified
copies of this license document, and changing it is allowed as long
as the name is changed.

DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

0. You just DO WHAT THE FUCK YOU WANT TO.
119 changes: 17 additions & 102 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,114 +1,29 @@
# Create a JavaScript Action
<p align="center"><a href="https://github.com/stanleynguyen/thanos" target="_blank"><img width="500"src="https://media.giphy.com/media/LOoaJ2lbqmduxOaZpS/giphy.gif"></a></p>

<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>
<a href="https://github.com/stanleynguyen/thanos/releases/latest"><img src="https://img.shields.io/github/release/stanleynguyen/thanos.svg"/></a>
<a href="https://github.com/stanleynguyen/thanos/actions?query=workflow%3Atest"><img src="https://github.com/stanleynguyen/thanos/workflows/test/badge.svg"/></a>
<a href="https://github.com/stanleynguyen/thanos/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-WTF-green.svg"/></a>
<p>

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

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 contains 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
👽 : 'Did you do it?'
😈 : 'Yes'
👽 : 'What did it cost?'
😈 : 'Everything...'
```

## Create a release branch
Every project should be perfectly balanced, as all things should be. Snap your project today!

Users shouldn't consume the action from master since that would be latest code and actions can break compatibility between major versions.
Checkout this [perfectly balanced demo project](https://github.com/stanleynguyen/thanos-demo).

Checkin to the v1 release branch

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

```bash
git push origin v1
```

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
with:
milliseconds: 1000
- name: Thanos Snap
uses: stanleynguyen/thanos@snap
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
```
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: Thanos Snap
description: 'Achieve the perfect balance for your projects'
author: 'Stanley Nguyen'
branding:
icon: 'git-commit'
color: 'purple'
inputs:
milliseconds: # id of input
description: 'number of milliseconds to wait'
github-token:
description: 'Pass in secrets.GITHUB_TOKEN'
required: true
default: '1000'
outputs:
time: # output will be available to future steps
description: 'The message to output'
runs:
using: 'node12'
main: 'dist/index.js'
Loading

0 comments on commit 8a716c5

Please sign in to comment.