Homebrew Releaser #3
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # .github/workflows/release.yml | |
| # Start Homebrew Releaser when a new GitHub release is created | |
| name: Homebrew Releaser | |
| on: | |
| release: | |
| types: [published] | |
| workflow_dispatch: | |
| jobs: | |
| homebrew-releaser: | |
| runs-on: ubuntu-latest | |
| name: homebrew-releaser | |
| steps: | |
| - name: Release my project to my Homebrew tap | |
| uses: Justintime50/homebrew-releaser@v1 | |
| with: | |
| # The name of the homebrew tap to publish your formula to as it appears on GitHub. | |
| # Required - strings | |
| homebrew_owner: xlith | |
| homebrew_tap: homebrew-lipsum-cli | |
| # The name of the folder in your homebrew tap where formula will be committed to. | |
| # Default is shown - string | |
| formula_folder: Formula | |
| # The Personal Access Token (saved as a repo secret) that has `repo` permissions for the repo running the action AND Homebrew tap you want to release to. | |
| # Required - string | |
| github_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }} | |
| # Git author info used to commit to the homebrew tap. | |
| # Defaults are shown - strings | |
| commit_owner: Civan Yavuzsen | |
| commit_email: [email protected] | |
| # Custom dependencies in case other formulas are needed to build the current one. | |
| # Optional - multiline string | |
| depends_on: | | |
| "rust" => :build | |
| # Custom install command for your formula. | |
| # Required - string | |
| install: 'system "cargo", "install", *std_cargo_args' | |
| # Custom test command for your formula so you can run `brew test`. | |
| # Optional - string | |
| test: 'system "cargo", "test", *std_cargo_args' | |
| # Allows you to set a custom download strategy. Note that you'll need | |
| # to implement the strategy and add it to your tap repository. | |
| # Example: https://docs.brew.sh/Formula-Cookbook#specifying-the-download-strategy-explicitly | |
| # Optional - string | |
| download_strategy: CurlDownloadStrategy | |
| # Allows you to add a custom require_relative at the top of the formula template. | |
| # Optional - string | |
| custom_require: '' | |
| # Adds URL and checksum targets for different OS and architecture pairs. Using this option assumes | |
| # a tar archive exists on your GitHub repo with the following URL pattern (this cannot be customized): | |
| # https://github.com/{GITHUB_OWNER}/{REPO_NAME}/releases/download/{TAG}/{REPO_NAME}-{VERSION}-{OPERATING_SYSTEM}-{ARCHITECTURE}.tar.gz' | |
| # Darwin AMD pre-existing path example: https://github.com/justintime50/myrepo/releases/download/v1.2.0/myrepo-1.2.0-darwin-amd64.tar.gz | |
| # Linux ARM pre-existing path example: https://github.com/justintime50/myrepo/releases/download/v1.2.0/myrepo-1.2.0-linux-arm64.tar.gz | |
| # Optional - booleans | |
| target_darwin_amd64: true | |
| target_darwin_arm64: false | |
| target_linux_amd64: true | |
| target_linux_arm64: false | |
| # Update your homebrew tap's README with a table of all projects in the tap. | |
| # This is done by pulling the information from all your formula.rb files - eg: | |
| # | |
| # | Project | Description | Install | | |
| # | ------------------------------------------ | ------------ | ------------------------ | | |
| # | [formula_1](https://github.com/user/repo1) | helpful text | `brew install formula_1` | | |
| # | [formula_2](https://github.com/user/repo2) | helpful text | `brew install formula_2` | | |
| # | [formula_3](https://github.com/user/repo3) | helpful text | `brew install formula_3` | | |
| # | |
| # Place the following in your README or wrap your project's table in these comment tags: | |
| # <!-- project_table_start --> | |
| # TABLE HERE | |
| # <!-- project_table_end --> | |
| # | |
| # Finally, mark `update_readme_table` as `true` in your GitHub Action config and we'll do the work of building a custom table for you. | |
| # Default is `false` - boolean | |
| update_readme_table: true | |
| # Skips committing the generated formula to a homebrew tap (useful for local testing). | |
| # Default is shown - boolean | |
| skip_commit: true | |
| # Logs debugging info to console. | |
| # Default is shown - boolean | |
| debug: true |