diff options
author | tusooa <tusooa@kazv.moe> | 2022-07-31 21:32:49 +0000 |
---|---|---|
committer | tusooa <tusooa@kazv.moe> | 2022-07-31 21:32:49 +0000 |
commit | c80096522cad1255f53e171359bc0266822c6441 (patch) | |
tree | 102a7e13b2e4c11af54e14a9ab0b3be216ce6013 /docs/development/setting_up_a_gitlab_runner.md | |
parent | 9a27cb4f9d314fe1066f566de71357f55926116e (diff) | |
parent | b5266097a1e73bd749d8176e327c14fcb9735f95 (diff) | |
download | pleroma-c80096522cad1255f53e171359bc0266822c6441.tar.gz pleroma-c80096522cad1255f53e171359bc0266822c6441.zip |
Merge branch 'develop' into 'from/develop/tusooa/emit-move'
# Conflicts:
# CHANGELOG.md
# test/pleroma/user_test.exs
Diffstat (limited to 'docs/development/setting_up_a_gitlab_runner.md')
-rw-r--r-- | docs/development/setting_up_a_gitlab_runner.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/development/setting_up_a_gitlab_runner.md b/docs/development/setting_up_a_gitlab_runner.md new file mode 100644 index 000000000..88beb82f2 --- /dev/null +++ b/docs/development/setting_up_a_gitlab_runner.md @@ -0,0 +1,9 @@ +# Setting up a Gitlab-runner + +When you push changes, a pipeline will start some automated jobs. These are done with so called [runners](https://docs.gitlab.com/runner/), services that run somewhere on a server and run these automated jobs. These jobs typically run tests and should pass. If not, you probably need to fix something. + +Generally, Pleroma provides a runner, so you don't need to set up your own. However, if for whatever reason you want to set up your own, here's some high level instructions. + +1. We use docker to run the jobs, so you should install that. For Debian, you need to allow non-free packages in the [source list](https://wiki.debian.org/SourcesList). Then you can install docker with `apt install docker-compose`. +2. You can [install](https://docs.gitlab.com/runner/install/index.html) and [configure](https://docs.gitlab.com/runner/register/index.html) a Gitlab-runner. It's probably easiest to install from the packages, but there are other options as well. +3. When registering the runner, you'll need some values. You can find them in the project under your own name. Choose "Settings", "CI/CD", and then expand "Runners". For executor you can choose "docker". For default image, you can use the image used in <https://git.pleroma.social/pleroma/pleroma/-/blob/develop/.gitlab-ci.yml#L1> (although it shouldn't matter much). |