Skip to content

Commit

Permalink
ci: add homebrew action and docs (#735)
Browse files Browse the repository at this point in the history
* ci: add homebrew step

* docs: add brew install

* fix: address feedback
  • Loading branch information
nitrocode authored and npalm committed Nov 10, 2024
1 parent 5c129f9 commit ccc0e80
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 1 deletion.
13 changes: 13 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,16 @@ jobs:
if: ${{ steps.release.outputs.release_created }}
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

homebrew:
name: "Bump Homebrew formula"
runs-on: ubuntu-latest
needs: release
steps:
- uses: mislav/bump-homebrew-formula-action@b3327118b2153c82da63fd9cbf58942146ee99f0 # v3
with:
# A PR will be sent to github.com/Homebrew/homebrew-core to update this formula
formula-name: action-docs
formula-path: Formula/a/action-docs.rb
env:
COMMITTER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,23 @@ Optionally you can also add the following section to generate a usage guide, rep
<!-- action-docs-usage source="action.yml" project="<project>" version="<version>" -->
```

### Generate docs via CLI
### Install

#### npm

```bash
npm install -g action-docs
```

#### brew

```bash
brew install action-docs
```

### Generate docs via CLI

```bash
cd <your github action>

# write docs to console
Expand Down

0 comments on commit ccc0e80

Please sign in to comment.