File tree Expand file tree Collapse file tree 2 files changed +31
-0
lines changed
Filter options
Expand file tree Collapse file tree 2 files changed +31
-0
lines changed
Original file line number Diff line number Diff line change @@ -21,6 +21,10 @@ documentation.
21
21
** Note** This action is still a bit of an experiment—the API may change in
22
22
* future versions. 🙂
23
23
24
+ ## Development
25
+
26
+ See [ development.md] ( /docs/development.md ) .
27
+
24
28
## Examples
25
29
26
30
Note that ` github-token ` is optional in this action, and the input is there
Original file line number Diff line number Diff line change
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.
You can’t perform that action at this time.
0 commit comments