-
Notifications
You must be signed in to change notification settings - Fork 1
/
Recipe_Template.cfg
123 lines (112 loc) · 6.65 KB
/
Recipe_Template.cfg
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
[Main]
# Main section. Required. This sets global properties on the recipe and specifies when this recipe is triggered.
# build_user: The user that will be running CIVET client.
build_user = moosebuild
# repository: The repository on which CIVET will listen for events to trigger this recipe
repository = [email protected]:idaholab/moose
# name: name of the recipe. Used for a more descriptive name that is shown on the user's recipe page
name = Moose Tutorial
# display_name: A shorter name that will be displayed for CIVET jobs
display_name = Tutorial
# help: Some help text describing what this recipe does
help = Builds and runs the MOOSE tutorial
# active: Bool. If False then this recipe won't be triggered
active = True
# private: Bool. If True then the results of this recipe are only viewable by collaborators.
private = False
# viewable_by_teams: List of comma separated teams that can view the results of this recipe
viewable_by_teams = idaholab/MOOSE Team, idaholab/MOOSE Private Apps
# trigger_push: Bool. If True then this recipe will be triggered on a push to the branch specified in trigger_push_branch
trigger_push = True
# trigger_push_branch: Branch name to trigger on push
trigger_push_branch = master
# priority_push: Priority for this recipe when it is triggered by a push.
# Priority determines in what order jobs are run. Higher priorities run first.
priority_push = 3
# auto_cancel_on_new_push: Bool. If True then when a new push event comes in, it will automatically cancel
# any previous running jobs that use this recipe (that got triggered on a push event).
auto_cancel_on_new_push = True
# automatic: One of "manual", "automatic", or "authorized".
# "manual": The job will have to be manually activated by a collaborator before it can be run
# "automatic": The job automatically is scheduled to run (when dependencies are set)
# "authorized": The job automatically is scheduled to run if the initiated user is a collaborator
automatic = automatic
# build_configs: A list of configurations that this recipe should be run against. Lists are comma separated.
build_configs = linux-gnu
# allow_on_pr: If True then a user can select this recipe to be run on a pull request (if it isn't already triggered on a PR)
allow_on_pr = True
# trigger_pull_request: If True then this recipe is triggered on pull requests
trigger_pull_request = True
# priority_pull_request: Priority for this recipe when it is triggered by a pull request.
# Priority determines in what order jobs are run. Higher priorities run first.
priority_pull_request = 53
# trigger_manual: Bool. If True then this recipe will be triggered via a manual event.
# This is typically used via cron that does a simple post to a URL to trigger this event.
# You will also need to specify trigger_manual_branch to specify what branch this will happen on.
# The latest SHA on that branch will be what this recipe operates on.
trigger_manual = True
# trigger_manual_branch: The branch to operate on a manual event
trigger_manual_branch = master
# priorty_manual: The priority a manual job runs with.
priority_manual = 0
#trigger_release: Bool. If True then this recipe will be triggered when there is a release event.
trigger_release = True
#priority_release: The priority when this is run on a release event
priority_release = 30
# client_runner_user: Username of the user that will be running the client.
# This is intended for the case where an outside user is going to be running a client
# and reporting it back to the main civet server. This will be different than the build_user.
client_runner_user = <username>
# create_issue_on_fail: Bool. If True and the recipe fails on a push or manual event, it automatically
# creates an issue on the git server.
create_issue_on_fail = True
# create_issue_on_fail_message: A string that will get added to the message on create_issue_on_fail
create_issue_on_fail_message = True
# create_issue_on_fail_new_comment: Bool. The default behavior for create_issue_on_fail is to just update the
# issue if they issue already exists. Setting this option to True will create a new comment if the
# issue already exists. This is useful because the git server will typically send
# out a new notification on new comments but not on updates to issues.
create_issue_on_fail_new_comment = True
# activate_label: Some arbitrary label name. This label gets attached to the recipe and allows for filtering
# of recipes on the server side.
# For example, the server can run only recipes that match a certain label if a certain set of files changed.
# For MOOSE, we have MOOSE_DOCUMENTATION label on the documentation recipe and that is the only thing that
# gets run on a PR when only documentation changes.
activate_label = <label>
[PullRequest Dependencies]
# Section for dependencies on pull requests. Optional. Specify the filename to the recipe.
# The key value can be anything, they just have to be unique.
# The filenames are relative to the top level of the repository.
filename0 = recipes/moosebuild/moose/Precheck.cfg
[Push Dependencies]
# Section for dependencies on pushes. Optional. Specify the filename to the recipe.
# The key value can be anything, they just have to be unique.
# The filenames are relative to the top level of the repository.
filename0 = recipes/moosebuild/moose/Precheck.cfg
[Global Sources]
# Section for scripts that will be sourced before every script in a step is run. Optional.
# Specify the filename to the script.
# The key value can be anything, they just have to be unique.
# The filenames are relative to the top level of the repository.
filename0 = scripts/env.sh
[Global Environment]
# Section for global environment. These key value pairs will be put into the environment
# and all steps will have access to them.
METHODS = opt
METHOD = opt
# For most scripts APPLICATION_REPO needs to be set as that is where they determine
# what directory and repo to operator on.
APPLICATION_REPO = [email protected]:idaholab/moose
# The remaining sections are all steps. Each of these sections must have a unique name.
# They will be executed in the same order that they are defined.
# File names are relative to the top level of the repository.
[Step 0]
# script: The script to run for this step
script = scripts/fetch_and_branch.sh
# abort_on_failure: Bool. If True then if this step fails then no further steps will be run.
abort_on_failure = True
# allowed_to_fail: Bool. If True then if this step fails it will be marked as "allowed to fail"
allowed_to_fail = False
# Any key value pairs in a step section will be put into the environment for that step.
# This includes the "abort_on_failure", "allowed_to_fail", and "script".
ENV_VAR = VALUE