Skip to content

Commit dc2e216

Browse files
Generate readme in CI
1 parent 9ec8261 commit dc2e216

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

Diff for: .github/workflows/main.yml

+14
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,14 @@ on:
88
jobs:
99
files-up-to-date:
1010
runs-on: ubuntu-latest
11+
permissions:
12+
pull-requests: write
13+
contents: write
1114
steps:
1215
- name: Checkout commit
1316
uses: actions/checkout@v3
17+
with:
18+
ref: ${{ github.event.pull_request.head.ref }}
1419

1520
- name: Read .nvmrc
1621
run: echo ::set-output name=NVMRC::$(cat .nvmrc)
@@ -28,6 +33,15 @@ jobs:
2833
- name: "`yarn format` changes committed?"
2934
run: yarn format:check
3035

36+
- name: Generate README
37+
run: |
38+
yarn gen-readme
39+
git config --global user.name github-actions[bot]
40+
git config --global user.email github-actions[bot]@users.noreply.github.com
41+
git add README.md
42+
git commit -m "Update README.md"
43+
git push
44+
3145
- name: "`yarn gen-readme` changes committed?"
3246
run: |
3347
yarn gen-readme

Diff for: docs/basic/setup.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This guide will always assume you are starting with the latest TypeScript and Re
1515
## VS Code Extensions
1616

1717
- refactoring help https://marketplace.visualstudio.com/items?itemName=paulshen.paul-typescript-toolkit
18-
- R+TS Code Snippets (there are a few...)
18+
- React+TypeScript Code Snippets (there are a few...)
1919
- https://marketplace.visualstudio.com/items?itemName=infeng.vscode-react-typescript
2020
- https://www.digitalocean.com/community/tutorials/the-best-react-extension-for-vs-code
2121
- TypeScript official extension https://code.visualstudio.com/docs/languages/typescript

0 commit comments

Comments
 (0)