mirror of
https://github.com/go-gitea/gitea.git
synced 2026-06-17 19:10:22 +03:00
bircni
c68925152b
Moves the "Hacking on Gitea" page out of the documentation website and into the repository as `docs/development.md`, so contributors find build and test instructions next to the code. The content has been cleaned up and corrected for in-repo use. --------- Signed-off-by: bircni <bircni@icloud.com> Co-authored-by: wxiaoguang <wxiaoguang@gmail.com> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
93 lines
3.6 KiB
Markdown
93 lines
3.6 KiB
Markdown
# Prepare build environment
|
|
|
|
Complete the steps in [build-setup.md](build-setup.md) to prepare your environment for building Gitea from source.
|
|
|
|
## Choose a branch
|
|
|
|
By default, the cloned repository is on main branch (the current development branch for next major release, aka: main nightly).
|
|
|
|
You can switch to a versioned branch (the branch for the next minor stable release, aka: stable nightly )
|
|
or a versioned tag (matches the official releases with version numbers)
|
|
|
|
To test a Pull Request, you can fetch its code by its Pull Request number (take `PR #123456` as example):
|
|
|
|
```bash
|
|
git fetch origin pull/123456/head:pr-123456
|
|
```
|
|
|
|
# Build
|
|
|
|
Various [make tasks](https://github.com/go-gitea/gitea/blob/main/Makefile)
|
|
are provided to keep the build process as simple as possible.
|
|
|
|
Depending on requirements, the following build tags can be included.
|
|
|
|
- `bindata`: Build a single monolithic binary, with all assets included. Required for distribution and production build.
|
|
- `pam`: Enable support for PAM (Linux Pluggable Authentication Modules).
|
|
Can be used to authenticate local users or extend authentication to methods available to PAM.
|
|
- `gogit`: (EXPERIMENTAL) Use go-git variants of Git commands.
|
|
|
|
To include all assets, use the `bindata` tag:
|
|
|
|
```bash
|
|
TAGS="bindata" make build
|
|
```
|
|
|
|
Tag `gogit` is used to try to resolve some Windows-specific performance problems, POSIX systems don't need it.
|
|
You can build a Windows binary by:
|
|
|
|
```bash
|
|
GOOS=windows TAGS="bindata gogit" make build
|
|
```
|
|
|
|
## Changing default paths
|
|
|
|
Gitea will search for a number of things from the _`CustomPath`_.
|
|
By default, this is the `custom/` directory in the current working directory when running Gitea.
|
|
It will also look for its configuration file _`CustomConf`_ in `$(CustomPath)/conf/app.ini`,
|
|
and will use the current working directory as the relative base path _`AppWorkPath`_.
|
|
|
|
These values, although useful when developing, may conflict with downstream users preferences.
|
|
|
|
For packagers who need to use paths like `/etc/gitea/app.ini`,
|
|
they should define these values at build time for `make build` by environment variable like
|
|
`LDFLAGS='-X "module.Var1=Value1" -X "module.Var2=Value2"' TAGS="bindata" make build`.
|
|
|
|
- _`CustomConf`_: `-X "code.gitea.io/gitea/modules/setting.CustomConf=/etc/gitea/app.ini"`
|
|
- _`AppWorkPath`_: `-X "code.gitea.io/gitea/modules/setting.AppWorkPath=/var/lib/gitea"`
|
|
- _`CustomPath`_: `-X "code.gitea.io/gitea/modules/setting.CustomPath=/var/lib/gitea/custom"`
|
|
- Default PID file location: `-X "code.gitea.io/gitea/cmd.PIDFile=/run/gitea.pid"`
|
|
|
|
Add as many of the strings with their preceding `-X` to the `LDFLAGS` variable and run `make build`
|
|
with the appropriate `TAGS` as above.
|
|
|
|
Running `gitea help` will allow you to review what the computed settings will be for your `gitea`.
|
|
|
|
## Cross Build
|
|
|
|
Gitea use's Golang's toolchain variables for cross-building.
|
|
|
|
For example, to cross build for Linux ARM64:
|
|
|
|
```
|
|
GOOS=linux GOARCH=arm64 TAGS="bindata" make build
|
|
```
|
|
|
|
### Adding shell autocompletion
|
|
|
|
Shell completion can be generated directly from binary with:
|
|
```sh
|
|
gitea completion <shell>
|
|
```
|
|
|
|
Supported values for `<shell>` are `bash`, `fish`, `pwsh` and `zsh`.
|
|
Details on how to load the completion for your shell can be found in the completion command help.
|
|
|
|
## Source Maps
|
|
|
|
By default, gitea generates reduced source maps for frontend files to conserve space. This can be controlled with the `ENABLE_SOURCEMAP` environment variable:
|
|
|
|
- `ENABLE_SOURCEMAP=true` generates all source maps, the default for development builds
|
|
- `ENABLE_SOURCEMAP=reduced` generates limited source maps, the default for production builds
|
|
- `ENABLE_SOURCEMAP=false` generates no source maps
|