Browse Source

contributing: add examples of tokens (#5828)

pull/5830/head
commitay 2 years ago
committed by Vítor Galvão
parent
commit
8ea86d5efd
1 changed files with 24 additions and 0 deletions
  1. +24
    -0
      CONTRIBUTING.md

+ 24
- 0
CONTRIBUTING.md View File

@ -2,6 +2,30 @@
All of the [instructions for contributing from the main repository](https://github.com/Homebrew/homebrew-cask/blob/master/CONTRIBUTING.md) apply, and won't be repeated here. You simply need to change references to `homebrew/homebrew-cask` (that repository) to `homebrew/homebrew-cask-versions` (this repository).
## Naming Versions Casks
All Cask names and tokens should be of the form of:
`<token><numbered version>` or `<token>-<pre-release type>`
### Versions Token Examples
Cask Token | `<token>-<numbered version>` | Filename
--------------------|------------------------------|------------------------
`alfred 2` | `alfred2` | `alfred2.rb`
`dash` | `dash3` | `dash3.rb`
`lingon-x` | `lingon-x5` | `lingon-x5.rb`
`transmit` | `transmit4` | `transmit4.rb`
Cask Token | `<token>-<pre-release type>` | Filename
--------------------|------------------------------|------------------------
`docker` | `docker-edge` | `docker-edge.rb`
`firefox` | `firefox-beta` | `firefox-beta.rb`
`sublime-text` | `sublime-text-dev` | `sublime-text-dev.rb`
`vlc` | `vlc-nightly` | `vlc-nightly.rb`
# Nightly Builds (Nightlies)
For Casks of [nightlies](https://en.wikipedia.org/wiki/Daily_build), `version`, `sha256`, and `url` change frequently, making the Cask constantly outdated. To alleviate having to regularly update them, the use of a [`url do` block](https://github.com/Homebrew/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/url.md#using-a-block-to-defer-code-execution) in conjunction with `version :latest` and `sha256 :no_check` is encouraged, to ensure the latest version is always fetched.

Loading…
Cancel
Save