Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 71 lines (43 sloc) 3.163 kb
b44768c @yrashk Added initial CONTRIBUTING.md
yrashk authored
1 CONTRIBUTING
2 ============
3
4 How can I suggest a new package?
5 --------------------------------
6
7 Just [open an issue](https://github.com/agner/agner/issues) with your suggestion.
8
9 How can I create a new package?
10 -------------------------------
11
12 You can create a spec repository by forking and renaming [template package repo](https://github.com/agner/agner.template)
13 and later on submitting it for inclusion by [opening an issue](https://github.com/agner/agner/issues).
14 The last step is only necessary if you want this package to be published on a "central" index.
15 If you want to keep it semi-private, you can just use it from your own index.
16
5010b7a @yrashk Added a little bit more information on tag shuffling to CONTRIBUTING.md
yrashk authored
17
18 Mastering specification
19 -----------------------
20
b2fcaa4 @yrashk Fixed broken link in README.md
yrashk authored
21 First of all, please take some time to read through [README](README.md) to make sure you understand all the concepts,
5010b7a @yrashk Added a little bit more information on tag shuffling to CONTRIBUTING.md
yrashk authored
22 especially how versioning is done.
23
24 Also, even though in Git world you can be crucified for deleting remote tags (`release` versions in our lingo), in Agner,
25 even not encouraged, this type of action is tolerable if you need to change the specification of an already published release.
26 `.agner` repos are intended for quick fresh cloning so shuffling tags in them is not that critical. If you do anticiapte anticipate that somebody has a fork of your `.agner` repo, though, please communicate your tag changes to them, just in case. One of
27 the ways might be adding some README or NOTES file into your `.agner` repo.
28
b44768c @yrashk Added initial CONTRIBUTING.md
yrashk authored
29 Before commiting your agner.config, please make sure you ran `agner verify` on it so it passes at least
5010b7a @yrashk Added a little bit more information on tag shuffling to CONTRIBUTING.md
yrashk authored
30 some validity checks.
31
90339e4 @yrashk Fixing markdown syntax in CONTRIBUTING.md
yrashk authored
32 ### Build command
d72210f @yrashk Added a little bit more information on how to define custom build & inst...
yrashk authored
33
34 If your target repository can't be built by simply invoking `rebar get-deps && rebar compile` then you need to supply
35 a `build_command` property, for example:
36
37
38 {build_command, "make"}.
39
40 The build command will be invoked in checked out directory containing target repository.
41
90339e4 @yrashk Fixing markdown syntax in CONTRIBUTING.md
yrashk authored
42 ### Install command
d72210f @yrashk Added a little bit more information on how to define custom build & inst...
yrashk authored
43
44 If your target repository can't be built by simply invoking `rebar get-deps && rebar compile` then you need to supply
45 a `install_command` property, for example:
46
47
48 {install_command, "make install"}.
49
50 The install command will be invoked in checked out directory containing target repository.
51
52
90339e4 @yrashk Fixing markdown syntax in CONTRIBUTING.md
yrashk authored
53 ### Environment Variables
d72210f @yrashk Added a little bit more information on how to define custom build & inst...
yrashk authored
54
55 Here's the current list of environmentvariables that will be available to build & install commands:
56
c4926b2 @yrashk Fixed a wrong word in CONTRIBUTING.md
yrashk authored
57 * AGNER -- Absolute path to the agner script file
7b2433c @yrashk Now every installed package is isolated in its own directory and can exp...
yrashk authored
58 * AGNER_PREFIX -- Root agner's directory (defaults to `/usr/local/agner`)
59
60 Here's the current list of environmentvariables that will be available to install command:
61
62 * AGNER_INSTALL_PREFIX -- A place where install procedure should consider putting installable files to. Right now it equates to
63 `AGNER_PREFIX/agner/packages/<package_name>-<package_version>`
d72210f @yrashk Added a little bit more information on how to define custom build & inst...
yrashk authored
64
65 More variables to come later.
1b43447 @yrashk Added documentation on hidden branches & tags in CONTRIBUTING.md
yrashk authored
66
b84bf97 @yrashk Very minor fix in CONTRIBUTING.md
yrashk authored
67 ### Private Branches & Tags
1b43447 @yrashk Added documentation on hidden branches & tags in CONTRIBUTING.md
yrashk authored
68
69 If you want to have either branches or tags that shouldn't be exposed to the end user as versions when they inquire using
70 `agner versions`, simply prepend your branch or tag name with `%` (comment) symbol and it will be hidden from the general public.
71 It will still be possible to use such versions explicitly, though (for example, `agner spec erlv8 -v @%test` for a branch called `%test`)
Something went wrong with that request. Please try again.