Skip to content

Commit ca91ad0

Browse files
authored
Merge pull request #4141 from eXist-db/update-homebrew-release-directions
Update Homebrew release directions
2 parents 69e84e3 + 4ee46cb commit ca91ad0

File tree

1 file changed

+4
-17
lines changed

1 file changed

+4
-17
lines changed

exist-versioning-release.md

Lines changed: 4 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -298,28 +298,15 @@ Central (staging), Docker images to Docker Hub, and eXist-db distributions and i
298298
### Releasing to Homebrew
299299
[Homebrew](http://brew.sh) is a popular command-line package manager for macOS. Once Homebrew is installed, applications like eXist can be installed via a simple command. eXist's presence on Homebrew is found in the Caskroom project, as a "cask", at [https://github.com/caskroom/homebrew-cask/blob/master/Casks/exist-db.rb](https://github.com/caskroom/homebrew-cask/blob/master/Casks/exist-db.rb).
300300

301-
> **Terminology:** "Caskroom" is the Homebrew extension project where pre-built binaries and GUI applications go, whereas the original "Homebrew" project is reserved for command-line utilities that can be built from source. Because the macOS version of eXist is released as an app bundle with GUI components, it is distributed via Caskroom.
301+
**Terminology:** "Homebrew Cask" is the segment of Homebrew where pre-built binaries and GUI applications go, whereas the original "Homebrew" project is reserved for command-line utilities that can be built from source. Because the macOS version of eXist-db is released as an app bundle with GUI components, it is handled as a Homebrew Cask.
302302

303-
When there is a new release of eXist, a member of the community can submit a pull request with the necessary changes to the eXist cask. [Follow the directions on the Homebrew-cask Github](https://github.com/caskroom/homebrew-cask/blob/master/CONTRIBUTING.md#updating-a-cask) - summarized here adapted to OpenRefine:
303+
When there is a new release of eXist, registering the new release with Homebrew can be easily accomplished using Homebrew's `brew bump-cask-pr` command. Full directions for this utility as well as procedures for more complex PRs can be found on [the Homebrew Cask CONTRIBUTING page](https://github.com/Homebrew/homebrew-cask/blob/master/CONTRIBUTING.md), but, a simple version bump is a one-line command. For example, to update Homebrew's version of eXist-db to 5.3.0, use this command:
304304

305305
```
306-
# install and setup script - only needed once
307-
brew install vitorgalvao/tiny-scripts/cask-repair
308-
cask-repair --help
309-
310-
# use to update eXist
311-
cask-repair exist-db
312-
```
313-
314-
The cask-repair tool will prompt you to enter the new version number. It will then use this version number to construct a download URL using the formula (where `{version}` represents the version number):
315-
316-
```
317-
https://github.com/eXist-db/exist/releases/download/eXist-{version}/eXist-db-{version}.dmg
306+
brew bump-cask-pr --version 5.3.0 exist-db
318307
```
319308

320-
**Note:** It is important that both version number components (the tag and version number) match, so that the formula can find the installer's URL.
321-
322-
Once cask-repair has successfully downloaded the new installer, it will calculate the new SHA-256 fingerprint value and construct a pull request, like this one: [https://github.com/caskroom/homebrew-cask/pull/42509](https://github.com/caskroom/homebrew-cask/pull/42509). Once the pull request is submitted, continuous integration tests will run, and a member of the caskroom community will review the PR. At times there is a backlog on the CI servers, but once tests pass, the community review is typically completed in a matter of hours.
309+
This command will cause your local Homebrew installation to download the new version of eXist-db, calculate the installer's new SHA-256 fingerprint value, and construct a pull request under your GitHub account, like [this one](https://github.com/Homebrew/homebrew-cask/pull/107778). Once the pull request is submitted, continuous integration tests will run, and a member of the Homebrew community will review the PR. At times there is a backlog on the CI servers, but once tests pass, the community review is typically completed in a matter of hours.
323310

324311
## Comparison to the Old Versioning and Release Procedures
325312

0 commit comments

Comments
 (0)