Skip to content

Commit

Permalink
Add development docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jclem committed Feb 13, 2020
1 parent c98effd commit 8e6ec0e
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ documentation.
**Note** This action is still a bit of an experiment—the API may change in
*future versions. 🙂

## Development

See [development.md](/docs/development.md).

## Examples

Note that `github-token` is optional in this action, and the input is there
Expand Down
27 changes: 27 additions & 0 deletions docs/development.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Development

## How this action works

This action works by evaluating the user input as the body of an asynchronous
JavaScript function. See [main.ts](/src/main.ts) for details.

## Building

Before the action can be used, it needs to be compiled to JavaScript:

```shell
bash> npm run build
```

It also has a pre-commit hook configured via
[husky](https://www.npmjs.com/package/husky) that should run the build script
before each commit.

## Releasing

Releases are done manually, for now:

1. Ensure that the build is up to date with `npm run build`.
1. Bump the [package.json](/package.json#L3) and [package-lock.json](/package-lock.json#L3) version numbers and commit them.
1. Update documentation (including updated version numbers).
1. Tag master with the new version number and create a GitHub release.

0 comments on commit 8e6ec0e

Please sign in to comment.