j7s_branch_trigger/README.md

33 lines
1.3 KiB
Markdown

# j7s-branch-trigger
Occasionally checks the state of branches on a provided repo
using `git remote ls`.
If the "branches of concern" have updated since it last looked,
it will send a POST to a web hook.
The "branches of concern" are defined using a configured web hook.
Designed to replicate Jenkins Multibranch Pipeline triggers for
Tekton in a way that is git provider agnostic.
## Configuration
Configuration is done through the following environment variables
which are checked at start up.
* `J7S_REPO` - **Required** the url of the repo to check in the format
you would hand `git clone`.
* `J7S_URL` - **Required** the url to post to if a change is seen.
* `J7S_HISTORY_FILE` - Default: '/tmp/branch-history.json' the location
to save the last seen state.
* `J7S_PATTERN` - Default: '^HEAD$' python flavored regex to find
branches of concern, for specific branch use '^refs/heads/branch$'
* `J7S_LOOPTIME` - Default: 1.0 minutes between checks of the state of
of the repo
* `J7S_ORG_NAME` - Default: "" the name of the org the repo is in in gitea.
Is addeded to the sent request.
* `J7S_REPO_NAME` - Default: "" the repo name which will be added to the
data posted to the event. Normally the thing right before .git in the clone
url.
* `J7S_JOB_NAME` = Default: "" name for this trigger. Added to the sent request.