Skip to content

update-brew-tap-toc-action

Actions
Reads the formulae stored in the tap (repo) and updates the list in the README
v2
Latest
Star (1)

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.

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.

# ...
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

Support

This project is made possible with the support of

QAware GmbH logo

update-brew-tap-toc-action is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Reads the formulae stored in the tap (repo) and updates the list in the README
v2
Latest

update-brew-tap-toc-action is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.