Add support for installing via homebrew

Open
#71 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
50/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
github-actions, python, shell
Domain
ci-cd, release

Research direction

The five steps span two repositories, so start by mapping this repo: the release/tag setup, the packaging config (pyproject/setup files), and the built-in updater's entry point that must detect a brew install and stand down. Then read the splunk/homebrew-tap repo structure and the Formula Cookbook links given in the issue to see what a formula and its sha256 pin require. Done means a formula exists in the tap, a GitHub Actions workflow updates its hash on each release, and brew upgrade alone drives updates for brew-managed installs.

Written by the indexing model from the issue text.

Description

Add support for installing via homebrew, these are the high level things that will need to be done, from my understanding:

  1. Cut versioned releases/tags so a formula has something stable to pin (url+sha256); a head block can track main in the meantime.
  2. Allow brew to manage the update lifecycle — the built-in updater needs to detect/disable itself under a brew install and defer entirely to brew upgrade, or we'll have two update systems fighting.
  3. Host it in our splunk tap  https://github.com/splunk/homebrew-tap rather than homebrew-core first — core has strict stability/notability bars this project doesn't need to clear yet.
  4. Write the formula and commit to the splunk tap.
  5. Setup github actions to auto update the hashes in the splunk tap on each release.

Resources:

Dominant language
Python
Stars
146
Forks
34
Avg merge
14h 35m
Merged PRs (30d)
64

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from splunk/token-meter

All issues in splunk/token-meter

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.