Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
tommykw committed Sep 17, 2020
1 parent e3cf74b commit dbc4a3d
Show file tree
Hide file tree
Showing 11 changed files with 6,483 additions and 264 deletions.
26 changes: 10 additions & 16 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -1,24 +1,18 @@
name: 'build-test'
on: # rebuild any PRs and main branch changes
pull_request:
name: 'reminder-test'
on:
push:
branches:
branches:
- main
- 'releases/*'

schedule:
- cron: '0 9,10 * * 1-5'

jobs:
build: # make sure build/ci work properly
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- run: |
npm install
- run: |
npm run all
test: # make sure the action works on a clean machine without building
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: ./
with:
milliseconds: 1000
github_token: ${{ secrets.GITHUB_TOKEN }}
reminder_message: 'レビュー開始から1営業日経過しました。レビューをなるべく優先しましょう。'
review_turnaround_hours: 2
123 changes: 26 additions & 97 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,101 +1,30 @@
<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>
<a href="https://github.com/tommykw/pull-request-reviewer-reminder-action/actions"><img alt="pull-request-reviewer-reminder-action status" src="https://github.com/tommykw/pull-request-reviewer-reminder-action/workflows/build-test/badge.svg"></a>
</p>

# Create a JavaScript Action using TypeScript

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
# Pull Request reviewer reminder action
[WIP]

Action to send Github mentions when there are pull requests pending for reviews. This action generated from [actions/typescript-action](https://github.com/actions/hello-world-javascript-action).

The difference from Github's scheduled reminders is that if they haven't been reviewed within the specified time, they will send a mention to the github reviewers. This is useful if you need to check by a certain time.

## Example Usage

```yml
name: 'Pull request reviewer reminder'
on:
schedule:
# Check reviews every weekday, 10:00 and 17:00
- cron: '0 10,17 * * 1-5'

jobs:
pull-request-reviewer-reminder:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
github_token: ${{ secrets.GITHUB_TOKEN }} # Required
reminder_message: 'One business day has passed since the review started. Give priority to reviews as much as possible.' # Required
within_hours: 24 # Required.
```

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
```

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))

```yaml
uses: ./
with:
milliseconds: 1000
```
See the [actions tab](https://github.com/actions/typescript-action/actions) for runs of this action! :rocket:
## 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
14 changes: 0 additions & 14 deletions __tests__/main.test.ts
Original file line number Diff line number Diff line change
@@ -1,21 +1,7 @@
import {wait} from '../src/wait'
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('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)
})

// shows how the runner will run a javascript action with env / stdout protocol
test('test runs', () => {
process.env['INPUT_MILLISECONDS'] = '500'
Expand Down
11 changes: 8 additions & 3 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,15 @@ name: 'Your name here'
description: 'Provide a description here'
author: 'Your name or organization here'
inputs:
milliseconds: # change this
github_token:
required: true
description: 'input description here'
default: 'default value if applicable'
description: 'GitHub token'
reminder_message:
required: true
description: 'Messages to send to reviewers on Github.'
review_turnaround_hours:
required: true
description: 'This is the deadline for reviews. If this time is exceeded, a reminder wil be send.'
runs:
using: 'node12'
main: 'dist/index.js'
Loading

0 comments on commit dbc4a3d

Please sign in to comment.