Skip to content

Commit ef03a3a

Browse files
authored
RFC for skip CI functionality (#177)
1 parent ee01887 commit ef03a3a

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

rfcs/0177-Skip-ci-integrations.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# RFC 177 - Skip CI in github integration
2+
* Comments: [#177](https://github.com/taskcluster/taskcluster-rfcs/pull/177)
3+
* Proposed by: @lotas
4+
5+
# Summary
6+
7+
Allow to skip running tasks for certain commits containing `[ci skip]`/`[skip ci]` keyword.
8+
9+
## Motivation
10+
11+
This will allow to save computing resources and give more flexibility for the Taskcluster users on Github.
12+
Not all commits require tasks to be run, for example, updating README.
13+
All major CI platforms provide this functionality.
14+
15+
# Details
16+
17+
This will be implemented in the webhook API handler. Depending on the `.taskcluster.yml` configuration, tasks could be created for both `push` and `pull-request` events, so we'll have to do those checks on both.
18+
19+
## `push` event
20+
21+
For the push event, we will check if the head commit includes one of the `[ci skip]`, `[skip ci]` keywords in its message. If message is found, this webhook event will be ignored. No messages will be published to the rabbitmq exchange, so no tasks will be started from this event.
22+
23+
If push consists of multiple commits, we would only check the head or the latest one.
24+
25+
## `pull_request` event
26+
27+
To prevent whole pull request from running tasks, we will check if its title contains `[ci skip]`, `[skip ci]` keywords.
28+
In this case, API handler will stop processing pull request event and will not publsh any event to the exchange. No tasks will be generated.
29+
30+
# Implementation
31+
32+
* Original request issue [#5311](https://github.com/taskcluster/taskcluster/issues/5311)
33+
* Initial imlpementation [#5612](https://github.com/taskcluster/taskcluster/pull/5612)
34+
* Ongoing fixes and improvements [#5617](https://github.com/taskcluster/taskcluster/pull/5617)

0 commit comments

Comments
 (0)