Skip to content

Commit

Permalink
Bootstrap (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
fwilhe2 authored Dec 27, 2020
1 parent 8c3b497 commit 51ed2c8
Show file tree
Hide file tree
Showing 14 changed files with 7,247 additions and 7,140 deletions.
2 changes: 1 addition & 1 deletion .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"@typescript-eslint/func-call-spacing": ["error", "never"],
"@typescript-eslint/no-array-constructor": "error",
"@typescript-eslint/no-empty-interface": "error",
"@typescript-eslint/no-explicit-any": "error",
// "@typescript-eslint/no-explicit-any": "error",
"@typescript-eslint/no-extraneous-class": "error",
"@typescript-eslint/no-for-in-array": "error",
"@typescript-eslint/no-inferrable-types": "error",
Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,3 @@ jobs:
steps:
- uses: actions/checkout@v2
- uses: ./
with:
milliseconds: 1000
108 changes: 10 additions & 98 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,103 +1,15 @@
<p align="center">
<a href="https://github.com/actions/typescript-action/actions"><img alt="typescript-action status" src="https://github.com/actions/typescript-action/workflows/build-test/badge.svg"></a>
</p>
# Bump Version

# Create a JavaScript Action using TypeScript
Gets the latest release version and increases it, useful for automatic releases.

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

This template includes compilation support, tests, 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
```

Build the typescript and package it for distribution
```bash
$ npm run build && npm run package
```

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
import * as core from '@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.

## Publish to a distribution branch

Actions are run from GitHub repos so we will checkin the packed dist folder.

Then run [ncc](https://github.com/zeit/ncc) and push the results:
```bash
$ npm run package
$ git add dist
$ git commit -a -m "prod dependencies"
$ git push origin releases/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)

## Validate

You can now validate the action by referencing `./` in a workflow in your repo (see [test.yml](.github/workflows/test.yml))
Example:

```yaml
uses: ./
with:
milliseconds: 1000
```
See the [actions tab](https://github.com/actions/typescript-action/actions) for runs of this action! :rocket:
- uses: fwilhe2/bump-version@main
id: bump
- run: echo ${{ steps.bump.outputs.newVersion }}

## Usage:
After testing you can [create a v1 tag](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) to reference the stable and latest V1 action
- uses: actions/create-release@v1
with:
tag_name: ${{ steps.bump.outputs.newVersion }}
```
26 changes: 15 additions & 11 deletions __tests__/main.test.ts
Original file line number Diff line number Diff line change
@@ -1,24 +1,28 @@
import {wait} from '../src/wait'
import {bump, currentVersion} from '../src/bump'
import * as process from 'process'
import * as cp from 'child_process'
import * as path from 'path'

test('throws invalid number', async () => {
const input = parseInt('foo', 10)
await expect(wait(input)).rejects.toThrow('milliseconds not a number')
// test('throws invalid number', async () => {
// const input = parseInt('foo', 10)
// await expect(wait(input)).rejects.toThrow('milliseconds not a number')
// })

test('Get current version of repo', async () => {
process.env['GITHUB_REPOSITORY'] = 'fwilhe2/ideal-journey'

const actual = await currentVersion()
expect(actual).toEqual('0.0.1')
})

test('wait 500 ms', async () => {
const start = new Date()
await wait(500)
const end = new Date()
var delta = Math.abs(end.getTime() - start.getTime())
expect(delta).toBeGreaterThan(450)
test('Bump semantic version', async () => {
const actual = bump('1.0.0')
expect(actual).toEqual('1.0.1')
})

// shows how the runner will run a javascript action with env / stdout protocol
test('test runs', () => {
process.env['INPUT_MILLISECONDS'] = '500'
process.env['GITHUB_REPOSITORY'] = 'fwilhe2/ideal-journey'
const np = process.execPath
const ip = path.join(__dirname, '..', 'lib', 'main.js')
const options: cp.ExecFileSyncOptions = {
Expand Down
10 changes: 5 additions & 5 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name: 'Your name here'
description: 'Provide a description here'
author: 'Your name or organization here'
name: 'Bump Version'
description: 'Bump version number to aid automated release processes'
author: 'Florian Wilhelm'
inputs:
milliseconds: # change this
required: true
not_needed: # change this
required: false
description: 'input description here'
default: 'default value if applicable'
runs:
Expand Down
Loading

0 comments on commit 51ed2c8

Please sign in to comment.