Skip to content

Commit

Permalink
feat: Implement codewatchers action
Browse files Browse the repository at this point in the history
  • Loading branch information
Christopher Manouvrier committed Jul 17, 2023
1 parent 37e9c21 commit 0394624
Show file tree
Hide file tree
Showing 13 changed files with 15,800 additions and 8,584 deletions.
1 change: 0 additions & 1 deletion .eslintignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
dist/
lib/
node_modules/
jest.config.js
5 changes: 2 additions & 3 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"plugins": ["jest", "@typescript-eslint"],
"plugins": ["@typescript-eslint"],
"extends": ["plugin:github/recommended"],
"parser": "@typescript-eslint/parser",
"parserOptions": {
Expand Down Expand Up @@ -49,7 +49,6 @@
},
"env": {
"node": true,
"es6": true,
"jest/globals": true
"es6": true
}
}
140 changes: 36 additions & 104 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,105 +1,37 @@
<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>

# 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

> First, you'll need to have a reasonably modern version of `node` handy. This won't work with versions older than 9, for instance.
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 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
## Table of contents

- [Introduction](#introduction)
- [Inputs](#inputs)
- [Usage](#usage)

## Introduction

This action set the assignees on a PR based of a CODEOWNERS file.

## Inputs

| input | description | required |
| ----------------------- | ---------------------------------------------------- | -------- |
| `github-token` | Auth token with permissions to label PR | `true` |
| `codewatchers-filename` | Filename of codewatchers file. Default: CODEWATCHERS | `false` |

## Usage

```yml
name: Add CODEWATCHERS
on:
pull_request:
types: [opened]
jobs:
add-assignees:
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: write
steps:
- name: Add CODEWATCHERS as assignees
uses: dovetail/codewatchers@latest
with:
codewatchers-filename: CODEWATCHERS
github-token: ${{ secrets.GITHUB_TOKEN }}
```

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

```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
29 changes: 0 additions & 29 deletions __tests__/main.test.ts

This file was deleted.

15 changes: 9 additions & 6 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
name: 'Your name here'
description: 'Provide a description here'
author: 'Your name or organization here'
name: 'codewatchers'
description: 'Set PR assignees based on a CODEOWNERS file'
author: 'dovetail'
inputs:
milliseconds: # change this
github-token:
required: true
description: 'input description here'
default: 'default value if applicable'
description: 'Auth token with permissions to label PR '
codewatchers-filename:
required: false
description: 'Filename of codewatchers file.'
default: 'CODEWATCHERS'
runs:
using: 'node16'
main: 'dist/index.js'
Loading

0 comments on commit 0394624

Please sign in to comment.