Skip to content

Commit 7a99cc1

Browse files
committed
Stage README for v0.0.6 release
1 parent 2a038c0 commit 7a99cc1

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ If the `checkUser` option is enabled, `forker` will check the specified GitHub o
1111

1212
For legal and compliance reasons, organizations or individuals can choose to provide an optional `licenseAllowlist` to compare against the [license of the repository](https://docs.github.com/en/rest/reference/licenses) being forked. If the license key returned by the GitHub API is not found within the provided allowlist, `forker` will exit without forking the repository, and display an error.
1313

14+
---
15+
1416
## Inputs
1517

1618
### `token` (string, required)
@@ -87,14 +89,16 @@ A string representing the HTTPS URL of the newly-forked repository.
8789

8890
**Example:** `"https://github.com/wayfair-contribs/tremor-runtime"`
8991

92+
---
93+
9094
## Usage
9195

9296
### Typical
9397

94-
In most cases, you'll want to use the latest stable version (eg. `v0.0.5`):
98+
In most cases, you'll want to use the latest stable version (eg. `v0.0.6`):
9599

96100
```yaml
97-
uses: wayfair-incubator/[email protected].5
101+
uses: wayfair-incubator/[email protected].6
98102
with:
99103
token: ${{ secrets.ACCESS_TOKEN }}
100104
repo: tremor-runtime
@@ -120,7 +124,7 @@ with:
120124
If you are automating the creation of forks on behalf of a GitHub organization with many users, you may wish to leverage the optional `checkUser`, `promoteUser`, and `licenseAllowlist` params:
121125

122126
```yaml
123-
uses: wayfair-incubator/[email protected].5
127+
uses: wayfair-incubator/[email protected].6
124128
with:
125129
token: ${{ secrets.ACCESS_TOKEN }}
126130
repo: tremor-runtime
@@ -132,6 +136,8 @@ with:
132136
licenseAllowlist: "0bsd\napache-2.0\nmit"
133137
```
134138

139+
---
140+
135141
## Developing
136142

137143
> 💡 **Tip:** Please use [node.js](https://nodejs.org/en/download/releases/) v17.x or later, as well as [TypeScript](https://www.npmjs.com/package/typescript) v4.x or later.
@@ -175,7 +181,7 @@ Then run [ncc](https://github.com/zeit/ncc) and push the results:
175181
npm run package
176182
git add dist
177183
git commit -a -m "prod dependencies"
178-
git push origin releases/v0.0.5
184+
git push origin releases/v0.0.6
179185
```
180186

181187
> 💡 **Tip:** 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.

0 commit comments

Comments
 (0)