Skip to content

docs: migrate 5 README files to a single NRG template #251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andriishin wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: migrate 5 README files to a single NRG template #251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions .github/workflows/nrg.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Regenerate READMEs
on:
push:
branches: [main]
paths:
- 'README.src.md'
- '.github/workflows/nrg.yml'
pull_request:
paths:
- 'README.md'
- 'README.es.md'
- 'README.id.md'
- 'README.pt.md'
- 'README.tr.md'
- 'README.src.md'
permissions:
contents: write
jobs:
regenerate:
if: github.event_name == 'push'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
- uses: nanolaba/nrg-action@v1
with:
file: README.src.md
nrg-version: '1.1'
- name: Commit regenerated READMEs
run: |
if [ -n "$(git status --porcelain README.md README.es.md README.id.md README.pt.md README.tr.md)" ]; then
git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
git add README.md README.es.md README.id.md README.pt.md README.tr.md
git commit -m "docs: regenerate READMEs from README.src.md"
git push
fi
drift-check:
if: github.event_name == 'pull_request'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: nanolaba/nrg-action@v1
with:
file: README.src.md
mode: check
nrg-version: '1.1'
2 changes: 2 additions & 0 deletions README.es.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!-- This file was automatically generated by Nanolaba Readme Generator (NRG) 1.1 -->
<!-- Visit https://github.com/nanolaba/readme-generator for details -->
<p align="center">
<img src="https://npkill.js.org/img/npkill-text-outlined.svg" width="320" alt="npkill logo" />
<img src="https://npkill.js.org/img/npkill-scope-mono.svg" width="50" alt="npkill logo scope" />
Expand Down
2 changes: 2 additions & 0 deletions README.id.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!-- This file was automatically generated by Nanolaba Readme Generator (NRG) 1.1 -->
<!-- Visit https://github.com/nanolaba/readme-generator for details -->
<p align="center">
<img src="https://npkill.js.org/img/npkill-text-outlined.svg" width="320" alt="npkill logo" />
<img src="https://npkill.js.org/img/npkill-scope-mono.svg" width="50" alt="npkill logo scope" />
Expand Down
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!-- This file was automatically generated by Nanolaba Readme Generator (NRG) 1.1 -->
<!-- Visit https://github.com/nanolaba/readme-generator for details -->
<p align="center">
<img src="./docs/npkill-text-clean.svg" width="380" alt="npkill logo" />
</p>
Expand Down
2 changes: 2 additions & 0 deletions README.pt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!-- This file was automatically generated by Nanolaba Readme Generator (NRG) 1.1 -->
<!-- Visit https://github.com/nanolaba/readme-generator for details -->
<p align="center">
<img src="https://npkill.js.org/img/npkill-text-outlined.svg" width="320" alt="npkill logo" />
<img src="https://npkill.js.org/img/npkill-scope-mono.svg" width="50" alt="npkill logo scope" />
Expand Down
Loading