Bennett/add-and-commit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(docs): switch to dynamic all-contributors badge

Browse Source
This commit is contained in:
Federico Grandi
2020-12-23 14:27:27 +01:00
parent 234011c0f7
commit dbf207a670
4 changed files with 1 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
.github/workflows/docs.yml vendored
View File

@@ -1,31 +0,0 @@
name: Docs
on:
push:
branches:
- master
paths:
- .all-contributorsrc
- .github/workflows/docs.yml
workflow_dispatch:
jobs:
contributors:
name: Update contributors badge
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v1
with:
node-version: 12.x
- run: npm install
- run: npm run all-contributors-badge
- uses: EndBug/add-and-commit@v4.0.0
with:
message: '[auto] docs: update contributors badge'
add: README.md
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

2
README.md
View File

@@ -1,7 +1,7 @@
# Add & Commit # Add & Commit
[![Public workflows that use this action.](https://img.shields.io/endpoint?url=https%3A%2F%2Fapi-git-master.endbug.vercel.app%2Fapi%2Fgithub-actions%2Fused-by%3Faction%3DEndBug%2Fadd-and-commit%26badge%3Dtrue)](https://github.com/search?o=desc&q=EndBug+add-and-commit+path%3A.github%2Fworkflows+language%3AYAML&s=&type=Code) [![Public workflows that use this action.](https://img.shields.io/endpoint?url=https%3A%2F%2Fapi-git-master.endbug.vercel.app%2Fapi%2Fgithub-actions%2Fused-by%3Faction%3DEndBug%2Fadd-and-commit%26badge%3Dtrue)](https://github.com/search?o=desc&q=EndBug+add-and-commit+path%3A.github%2Fworkflows+language%3AYAML&s=&type=Code)
[![All Contributors](https://img.shields.io/badge/all_contributors-21-orange.svg?style=flat)](#contributors-) [![All Contributors](https://img.shields.io/github/all-contributors/EndBug/add-and-commit)](#contributors-)
You can use this GitHub Action to commit changes made in your workflow run directly to your repo: for example, you use it to lint your code, update documentation, commit updated builds, etc.... You can use this GitHub Action to commit changes made in your workflow run directly to your repo: for example, you use it to lint your code, update documentation, commit updated builds, etc....

1
package.json
View File

@@ -8,7 +8,6 @@
"watch": "ncc build src/main.ts --watch --out lib", "watch": "ncc build src/main.ts --watch --out lib",
"lint": "eslint --ext .ts src", "lint": "eslint --ext .ts src",
"lint:fix": "eslint --ext .ts --fix src", "lint:fix": "eslint --ext .ts --fix src",
"all-contributors-badge": "ts-node scripts/all-contributors-badge",
"changelog": "ts-node scripts/changelog.ts && npm i", "changelog": "ts-node scripts/changelog.ts && npm i",
"test": "echo \"Error: no test specified\" && exit 1" "test": "echo \"Error: no test specified\" && exit 1"
}, },

24
scripts/all-contributors-badge.ts
View File

@@ -1,24 +0,0 @@
import * as fs from 'fs'
import { resolve } from 'path'
function path(...segments: string[]) {
return resolve(__dirname, '..', ...segments)
}
const README = fs.readFileSync(path('README.md'), { encoding: 'utf8' }),
{ contributors } = JSON.parse(
fs.readFileSync(path('.all-contributorsrc'), { encoding: 'utf8' })
)
if (!(contributors instanceof Array)) throw new Error('Invalid config file')
const updatedREADME = README.split('\n')
.map((line) =>
line.startsWith(
'[![All Contributors](https://img.shields.io/badge/all_contributors-'
)
? `[![All Contributors](https://img.shields.io/badge/all_contributors-${contributors.length}-orange.svg?style=flat)](#contributors-)`
: line
)
.join('\n')
fs.writeFileSync(path('README.md'), updatedREADME)