Files
GitBucket/doc/build.md
Naoki Takezoe de72a9223f Update build.md
2021-03-02 20:48:58 +09:00

62 lines
1.4 KiB
Markdown

How to build and run from the source tree
========
First of all, Install [sbt](http://www.scala-sbt.org/index.html).
```shell
$ brew install sbt
```
Run for Development
--------
If you want to test GitBucket, type the following command in the root directory of the source tree.
```shell
$ sbt ~jetty:start
```
Then access `http://localhost:8080/` in your browser. The default administrator account is `root` and password is `root`.
Source code modifications are detected and a reloading happens automatically. You can modify the logging configuration by editing `src/main/resources/logback-dev.xml`.
Build war file
--------
To build a war file, run the following command:
```shell
$ sbt package
```
`gitbucket_2.13-x.x.x.war` is generated into `target/scala-2.13`.
To build an executable war file, run
```shell
$ sbt executable
```
at the top of the source tree. It generates executable `gitbucket.war` into `target/executable`. We release this war file as release artifact.
Run tests spec
---------
Before running tests, you need to install docker.
```shell
$ brew cask install docker # Install Docker
$ open /Applications/Docker.app # Start Docker
```
To run the full series of tests, run the following command:
```shell
$ sbt test
```
If you don't have docker, you can skip docker tests which require docker as follows:
```shell
$ sbt "testOnly * -- -l ExternalDBTest"
```