Skip to content
This repository has been archived by the owner on Sep 11, 2023. It is now read-only.

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
xlc committed Aug 27, 2023
1 parent 2b8398c commit 2e927d7
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 103 deletions.
125 changes: 23 additions & 102 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,105 +1,26 @@
<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>
# Fellowship Process Bot

## Example usage

- Create a `.github/workflows/process.yml` GH action workflow

```yml
name: Process Bot
on:
issue_comment:
types: [created] # only trigger on new issue comments
env:
GH_TOKEN: ${{ secrets.GH_PAT }} # authorize bot
jobs:
process:
name: Process Comment
# only run if the comment is on a PR and starts with /bot
if: ${{ github.event.issue.pull_request && startsWith(github.event.comment.body, '/bot ') }}
runs-on: ubuntu-latest
steps:
- uses: xlc/fellowship-process-bot@main

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

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
- Create PAT token with read and write permission for pull requests.
- Provide the PAT token to the GH action with repo secrets `GH_PAT`
4 changes: 4 additions & 0 deletions dist/index.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/index.js.map

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions src/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import processCmd from './process'
const main = async () => {
const rawcmd: string = github.context.payload.comment?.body
if (!rawcmd) {
console.log('No comment body found')
return
}

Expand All @@ -20,7 +21,10 @@ const main = async () => {
issue_number: github.context.issue.number
})

console.log(result)

if (!result) {
console.log('No result')
return
}

Expand Down
1 change: 1 addition & 0 deletions src/process.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ type Context = {
const processCmd = async (octokit: ReturnType<typeof github.getOctokit>, rawcmd: string, ctx: Context) => {
const { cmd, getArg, rawArgs } = parse(rawcmd)
if (!cmd) {
console.log('No command found')
return
}

Expand Down

0 comments on commit 2e927d7

Please sign in to comment.