Skip to content
Snippets Groups Projects
Commit 2ba876f0 authored by Marin Jankovski's avatar Marin Jankovski
Browse files

Move build doc and link to the new location.

parent 05654be1
No related branches found
No related tags found
1 merge request!410Major docs update
Loading
Loading
@@ -390,14 +390,14 @@ See [doc/settings/database.md](doc/settings/database.md).
 
## Building your own package
 
See [the separate build documentation](doc/build.md).
See [the separate build documentation](doc/build/README.md).
 
## Running a custom GitLab version
 
It is not recommended to make changes to any of the files in `/opt/gitlab`
after installing omnibus-gitlab: they will either conflict with or be
overwritten by future updates. If you want to run a custom version of GitLab
you can [build your own package](doc/build.md) or use [another installation
you can [build your own package](doc/build/README.md) or use [another installation
method][CE README].
 
## Acknowledgments
Loading
Loading
Loading
Loading
@@ -38,7 +38,7 @@
 
- [Development Setup](doc/development/README.md)
- [Release process](doc/release/README.md)
- [Building your own package](build.md)
- [Building your own package](doc/build/README.md)
 
 
 
Loading
Loading
# Preparing a build environment
#### Preparing a build environment
 
See
https://gitlab.com/gitlab-org/gitlab-omnibus-builder/blob/master/README.md#recipe-default
for instructions on how to prepare a build box using Chef. After running the
cookbook you can perform builds as the `omnibus-build` user.
See [doc/build/README.md.](doc/build/README.md#preparing-a-build-environment)
 
```shell
# Login as omnibus-build user
sudo su - omnibus-build
#### Usage
 
# Clone the omnibus repo
git clone https://gitlab.com/gitlab-org/omnibus-gitlab.git
See [doc/build/README.md.](doc/build/README.md#usage)
 
# Install gem dependencies for omnibus-ruby
cd omnibus-gitlab
bundle install --path .bundle --binstubs
#### Build
 
# Do a build
bin/omnibus build gitlab
```
See [doc/build/README.md.](doc/build/README.md#build)
 
## Usage
#### Clean
 
### Build
See [doc/build/README.md.](doc/build/README.md#clean)
 
You create a platform-specific package using the `build` command:
#### Help
 
```shell
$ bin/omnibus build gitlab
```
The platform/architecture type of the package created will match the platform
where the `build project` command is invoked. So running this command on say a
MacBook Pro will generate a Mac OS X specific package. After the build
completes packages will be available in `pkg/`.
### Clean
You can clean up all temporary files generated during the build process with
the `clean` command:
```shell
$ bin/omnibus clean
```
Adding the `--purge` purge option removes __ALL__ files generated during the
build including the project install directory (`/opt/gitlab`) and
the package cache directory (`/var/cache/omnibus/pkg`):
```shell
$ bin/omnibus clean --purge
```
### Help
Full help for the Omnibus command line interface can be accessed with the
`help` command:
```shell
$ bin/omnibus help
```
See [doc/build/README.md.](doc/build/README.md#help)
# Preparing a build environment
See
https://gitlab.com/gitlab-org/gitlab-omnibus-builder/blob/master/README.md#recipe-default
for instructions on how to prepare a build box using Chef. After running the
cookbook you can perform builds as the `omnibus-build` user.
```shell
# Login as omnibus-build user
sudo su - omnibus-build
# Clone the omnibus repo
git clone https://gitlab.com/gitlab-org/omnibus-gitlab.git
# Install gem dependencies for omnibus-ruby
cd omnibus-gitlab
bundle install --path .bundle --binstubs
# Do a build
bin/omnibus build gitlab
```
## Usage
### Build
You create a platform-specific package using the `build` command:
```shell
$ bin/omnibus build gitlab
```
The platform/architecture type of the package created will match the platform
where the `build project` command is invoked. So running this command on say a
MacBook Pro will generate a Mac OS X specific package. After the build
completes packages will be available in `pkg/`.
### Clean
You can clean up all temporary files generated during the build process with
the `clean` command:
```shell
$ bin/omnibus clean
```
Adding the `--purge` purge option removes __ALL__ files generated during the
build including the project install directory (`/opt/gitlab`) and
the package cache directory (`/var/cache/omnibus/pkg`):
```shell
$ bin/omnibus clean --purge
```
### Help
Full help for the Omnibus command line interface can be accessed with the
`help` command:
```shell
$ bin/omnibus help
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment