Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 8e6ec0e

Browse filesBrowse files
committed
Add development docs
1 parent c98effd commit 8e6ec0e
Copy full SHA for 8e6ec0e

File tree

Expand file treeCollapse file tree

2 files changed

+31
-0
lines changed
Filter options
Expand file treeCollapse file tree

2 files changed

+31
-0
lines changed

‎README.md

Copy file name to clipboardExpand all lines: README.md
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ documentation.
2121
**Note** This action is still a bit of an experiment—the API may change in
2222
*future versions. 🙂
2323

24+
## Development
25+
26+
See [development.md](/docs/development.md).
27+
2428
## Examples
2529

2630
Note that `github-token` is optional in this action, and the input is there

‎docs/development.md

Copy file name to clipboard
+27Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Development
2+
3+
## How this action works
4+
5+
This action works by evaluating the user input as the body of an asynchronous
6+
JavaScript function. See [main.ts](/src/main.ts) for details.
7+
8+
## Building
9+
10+
Before the action can be used, it needs to be compiled to JavaScript:
11+
12+
```shell
13+
bash> npm run build
14+
```
15+
16+
It also has a pre-commit hook configured via
17+
[husky](https://www.npmjs.com/package/husky) that should run the build script
18+
before each commit.
19+
20+
## Releasing
21+
22+
Releases are done manually, for now:
23+
24+
1. Ensure that the build is up to date with `npm run build`.
25+
1. Bump the [package.json](/package.json#L3) and [package-lock.json](/package-lock.json#L3) version numbers and commit them.
26+
1. Update documentation (including updated version numbers).
27+
1. Tag master with the new version number and create a GitHub release.

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.