haskell/stackage
1
0
Fork 0
mirror of https://github.com/commercialhaskell/stackage.git synced 2026-01-15 00:38:29 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Document slug limitations

snoyberg 2014-12-02 06:34:21 -08:00
parent 4e97f48f6a
commit 1f5f87c0f4
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Experimental-package-releases-via-Stackage-Server.md

@ -42,6 +42,7 @@ files recognized:
* `desc` gives the human-readable title and description for the snapshot. Put the title on the first line, and the description on the following lines. (Note that, currently, we *only* display the title on the site, though we may add the description to the display in the future.)
* `slug` is a recommendation for the short name of the snapshot. For example, the [most recent GHC 7.8 snapshot](http://www.stackage.org/snapshot/2014-11-26-ghc78-exc) as I write this is `http://www.stackage.org/snapshot/2014-11-26-ghc78-exc`, which has a slug of `2014-11-26-ghc78-exc`. Slugs must be globally unique, so if someone else has already taken that slug, Stackage Server will append a randomized token to the end.
* Note: slugs have a minimum length of three characters, and a maximum length of thirty characters, and consist of alphanumerics, dashes and underscores.
* `hackage` is a list of all the package/version combos to be included in this snapshot from Hackage. For example, you might have: