From 8f1908614d6df6cacabe8e18559dc83f5727050f Mon Sep 17 00:00:00 2001 From: Anton Gusev Date: Sun, 14 Feb 2021 19:19:32 +0300 Subject: Document BUILD_SUBMITTER and BUILD_REASON environment variables in build.sr.ht documentation Environment variables BUILD_SUBMITTER and BUILD_REASON that show information about integrations are implemented, but not documented. This patch adds them to the list of environment variables and adds their values to the respective integration pages. Made in response to https://lists.sr.ht/~sircmpwn/sr.ht-discuss/<20210213233602.4dd7ae3113379f443fc0468e@mail.ru> --- builds.sr.ht/index.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/builds.sr.ht/index.md b/builds.sr.ht/index.md index c30dc2b..cf676f5 100644 --- a/builds.sr.ht/index.md +++ b/builds.sr.ht/index.md @@ -111,6 +111,13 @@ The following environment variables are defined for all builds: - **JOB_URL**: The URL at which the build logs and information can be viewed with a web browser +The following environment variables are commonly added by +[integrations](#integrations): + +- **BUILD_SUBMITTER**: The name of the integration which submitted the job +- **BUILD_REASON**: The reason the integration submitted the build + + # Build status badges If you add tags to your build, or enter search terms, you can use these to @@ -143,8 +150,25 @@ sources array, we'll edit it to point to the ref you just pushed. You can also submit up to 4 builds on each push by providing `.builds/*.yml` (if more are submitted, 4 manifests will be randomly chosen). +**Environment** + +- `BUILD_SUBMITTER`: `git.sr.ht` + ## hg.sr.ht hg.sr.ht will also automatically submit builds for you. The naming conventions and other details are the same as the process used by git.sr.ht - described above. + +**Environment** + +- `BUILD_SUBMITTER`: `hg.sr.ht` + +## hub.sr.ht + +hub.sr.ht will automatically submit builds when a patch to a repo with `.build.yml` is sent to a mailing list. + +**Environment** + +- `BUILD_SUBMITTER`: `hub.sr.ht` +- `BUILD_REASON`: `patchset` -- cgit