Skip to content
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

ci: add homebrew action and docs #735

Merged
merged 3 commits into from
Nov 10, 2024
Merged

ci: add homebrew action and docs #735

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
77777ec
ci: add homebrew step
nitrocode Oct 28, 2024
abcb4dd
docs: add brew install
nitrocode Oct 28, 2024
4c64767
fix: address feedback
nitrocode Oct 30, 2024
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
13 changes: 13 additions & 0 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,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
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you test the action on a branch with the release? Looking at the docs, I think we should set tag-name with the output of the release.

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 }}
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this won't work, it seems a PAT token is required here bacause as far I understand the token is used to open the PR or commit code to a PR. The GitHub token can't do that. It can only act in repo scop.

15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
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