Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qaware/update-brew-tap-toc-action
Update your homebrew tap's README with a TOC
https://github.com/qaware/update-brew-tap-toc-action
actions brew github homebrew homebrew-tap
Last synced: about 1 month ago
JSON representation
Update your homebrew tap's README with a TOC
- Host: GitHub
- URL: https://github.com/qaware/update-brew-tap-toc-action
- Owner: qaware
- License: mit
- Created: 2024-07-28T18:08:44.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-08-01T15:52:41.000Z (4 months ago)
- Last Synced: 2024-09-30T23:23:41.030Z (about 2 months ago)
- Topics: actions, brew, github, homebrew, homebrew-tap
- Language: Shell
- Homepage:
- Size: 9.77 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# update-brew-tap-toc-action
This GitHub action reads the Homebrew tap folder and procduces a table of content.
The list of formulae is then placed in the specified files, eg. your README.md.
## Example
An example workflow can look like.
```yaml
name: Update TOC
run-name: Update TOC 🚀
on:
push:
branches:
- main
paths:
- Formula/*.rb
- README.md
jobs:
update-toc:
runs-on: ubuntu-latest
steps:
- name: Check out repository code
uses: actions/checkout@v4
- name: Update TOC
uses: qaware/update-brew-tap-toc-action@main
- name: Commit & Push changes
# Use some action that fits your needs
```
You can pass options.
```yaml
# ...
steps:
- name: Update TOC
uses: qaware/update-brew-tap-toc-action@main
with:
formula-folder: Formula-cstm
replace-in: README.md,TOC.md,docs/content.adoc
replace-marker-start: '// START TOC'
replace-marker-end: '// END TOC'
```
## Maintainers
* Alexander Eimer ([@aeimer](https://github.com/aeimer))
## Support
This project is made possible with the support of
[](https://qaware.de)