blob: 382a07a4212cfc8a91d0a5b7c12c0e8106e5ad5c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
asdf Omnibus project
====================
This project creates full-stack platform-specific packages for
`asdf`!
Installation
------------
You must have a sane Ruby 2.0.0+ environment with Bundler installed. Ensure all
the required gems are installed:
```shell
$ bundle install --binstubs
```
Usage
-----
### Build
You create a platform-specific package using the `build project` command:
```shell
$ bin/omnibus build asdf
```
The platform/architecture type of the package created will match the platform
where the `build project` command is invoked. For example, running this command
on a MacBook Pro will generate a Mac OS X package. After the build completes
packages will be available in the `pkg/` folder.
### Clean
You can clean up all temporary files generated during the build process with
the `clean` command:
```shell
$ bin/omnibus clean asdf
```
Adding the `--purge` purge option removes __ALL__ files generated during the
build including the project install directory (`/opt/asdf`) and
the package cache directory (`/var/cache/omnibus/pkg`):
```shell
$ bin/omnibus clean asdf --purge
```
### Publish
Omnibus has a built-in mechanism for releasing to a variety of "backends", such
as Amazon S3. You must set the proper credentials in your
[`omnibus.rb`](omnibus.rb) config file or specify them via the command line.
```shell
$ bin/omnibus publish path/to/*.deb --backend s3
```
### Help
Full help for the Omnibus command line interface can be accessed with the
`help` command:
```shell
$ bin/omnibus help
```
Version Manifest
----------------
Git-based software definitions may specify branches as their
default_version. In this case, the exact git revision to use will be
determined at build-time unless a project override (see below) or
external version manifest is used. To generate a version manifest use
the `omnibus manifest` command:
```
omnibus manifest PROJECT -l warn
```
This will output a JSON-formatted manifest containing the resolved
version of every software definition.
|
