github.com/nilium/gitlab-runner@v12.5.0+incompatible/PROCESS.md (about) 1 ## GitLab core team & GitLab Inc. contribution process 2 3 --- 4 5 <!-- START doctoc generated TOC please keep comment here to allow auto update --> 6 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> 7 **Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* 8 9 - [Be kind](#be-kind) 10 - [Feature freeze on the 7th for the release on the 22nd](#feature-freeze-on-the-7th-for-the-release-on-the-22nd) 11 - [Between the 1st and the 7th](#between-the-1st-and-the-7th) 12 - [What happens if these deadlines are missed?](#what-happens-if-these-deadlines-are-missed) 13 - [On the 7th](#on-the-7th) 14 - [After the 7th](#after-the-7th) 15 - [Asking for an exception](#asking-for-an-exception) 16 - [Bugs](#bugs) 17 - [Regressions](#regressions) 18 - [Managing bugs](#managing-bugs) 19 - [Supported releases](#supported-releases) 20 - [Releasing GitLab Runner](#releasing-gitlab-runner) 21 - [Copy & paste responses](#copy--paste-responses) 22 - [Improperly formatted issue](#improperly-formatted-issue) 23 - [Issue report for old version](#issue-report-for-old-version) 24 - [Support requests and configuration questions](#support-requests-and-configuration-questions) 25 - [Code format](#code-format) 26 - [Issue fixed in newer version](#issue-fixed-in-newer-version) 27 - [Improperly formatted merge request](#improperly-formatted-merge-request) 28 - [Accepting merge requests](#accepting-merge-requests) 29 - [Only accepting merge requests with green tests](#only-accepting-merge-requests-with-green-tests) 30 31 <!-- END doctoc generated TOC please keep comment here to allow auto update --> 32 33 --- 34 35 ## Be kind 36 37 Be kind to people trying to contribute. Be aware that people may be a non-native 38 English speaker, they might not understand things or they might be very 39 sensitive as to how you word things. Use Emoji to express your feelings (heart, 40 star, smile, etc.). Some good tips about code reviews can be found in our 41 [Code Review Guidelines]. 42 43 [Code Review Guidelines]: https://docs.gitlab.com/ce/development/code_review.html 44 45 ## Feature freeze on the 7th for the release on the 22nd 46 47 After 7th at 23:59 (Pacific Time Zone) of each month, stable branch and RC1 48 of the upcoming release (to be shipped on the 22nd) is created and deployed to GitLab.com. 49 The stable branch is frozen at the most recent "qualifying commit" on master. 50 A "qualifying commit" is one that is pushed before the feature freeze cutoff time 51 and that passes all CI jobs (green pipeline). 52 53 Merge requests may still be merged into master during this 54 period, but they will go into the _next_ release, unless they are manually 55 cherry-picked into the stable branch. 56 57 By freezing the stable branches 2 weeks prior to a release, we reduce the risk 58 of a last minute merge request potentially breaking things. 59 60 Any release candidate that gets created after this date can become a final 61 release, hence the name release candidate. 62 63 ### Between the 1st and the 7th 64 65 These types of merge requests for the upcoming release need special consideration: 66 67 - **Large features**: a large feature is one that is highlighted in the kick-off 68 and the release blogpost; typically this will have its own channel in Slack 69 and a dedicated team with front-end, back-end, and UX. 70 - **Small features**: any other feature request. 71 72 It is strongly recommended that **large features** be with a maintainer **by the 73 1st**. This means that: 74 75 - There is a merge request (even if it's WIP). 76 - The person (or people, if it needs a frontend and backend maintainer) who will 77 ultimately be responsible for merging this have been pinged on the MR. 78 79 It's OK if merge request isn't completely done, but this allows the maintainer 80 enough time to make the decision about whether this can make it in before the 81 freeze. If the maintainer doesn't think it will make it, they should inform the 82 developers working on it and the Product Manager responsible for the feature. 83 84 The maintainer can also choose to assign a reviewer to perform an initial 85 review, but this way the maintainer is unlikely to be surprised by receiving an 86 MR later in the cycle. 87 88 It is strongly recommended that **small features** be with a reviewer (not 89 necessarily a maintainer) **by the 3rd**. 90 91 Most merge requests from the community do not have a specific release 92 target. However, if one does and falls into either of the above categories, it's 93 the reviewer's responsibility to manage the above communication and assignment 94 on behalf of the community member. 95 96 Every new feature or change should be shipped with its corresponding documentation 97 in accordance with the 98 [documentation process](https://docs.gitlab.com/ee/development/documentation/feature-change-workflow.html) 99 and [structure](https://docs.gitlab.com/ee/development/documentation/structure.html) guides. 100 Note that a technical writer will review all changes to documentation. This can occur 101 in the same MR as the feature code, but [if there is not sufficient time or need, 102 it can be planned via a follow-up issue for doc review](https://docs.gitlab.com/ee/development/documentation/feature-change-workflow.html#1-product-managers-role), 103 and another MR, if needed. Regardless, complete docs must be merged with code by the freeze. 104 105 #### What happens if these deadlines are missed? 106 107 If a small or large feature is _not_ with a maintainer or reviewer by the 108 recommended date, this does _not_ mean that maintainers or reviewers will refuse 109 to review or merge it, or that the feature will definitely not make it in before 110 the feature freeze. 111 112 However, with every day that passes without review, it will become more likely 113 that the feature will slip, because maintainers and reviewers may not have 114 enough time to do a thorough review, and developers may not have enough time to 115 adequately address any feedback that may come back. 116 117 A maintainer or reviewer may also determine that it will not be possible to 118 finish the current scope of the feature in time, but that it is possible to 119 reduce the scope so that something can still ship this month, with the remaining 120 scope moving to the next release. The sooner this decision is made, in 121 conversation with the Product Manager and developer, the more time there is to 122 extract that which is now out of scope, and to finish that which remains in scope. 123 124 For these reasons, it is strongly recommended to follow the guidelines above, 125 to maximize the chances of your feature making it in before the feature freeze, 126 and to prevent any last minute surprises. 127 128 ### On the 7th 129 130 Merge requests should still be complete, following the [definition of 131 done](https://docs.gitlab.com/ee/development/contributing/merge_request_workflow.html#definition-of-done). 132 133 If a merge request is not ready, but the developers and Product Manager 134 responsible for the feature think it is essential that it is in the release, 135 they can [ask for an exception](#asking-for-an-exception) in advance. This is 136 preferable to merging something that we are not confident in, but should still 137 be a rare case: most features can be allowed to slip a release. 138 139 ### After the 7th 140 141 Once the stable branch is frozen, the only MRs that can be cherry-picked into 142 the stable branch are: 143 144 - Fixes for [regressions](#regressions) where the affected version `xx.x` in `regression:xx.x` is the current release. See [Managing bugs](#managing-bugs) section. 145 - Fixes for security issues. 146 - Fixes or improvements to automated QA scenarios. 147 - [Documentation improvements](https://docs.gitlab.com/ee/development/documentation/workflow.html) for feature changes made in the same release, though initial docs for these features should have already been merged by the freeze, as required. 148 - New or updated translations (as long as they do not touch application code). 149 - Changes that are behind a feature flag and have the ~"feature flag" label. 150 151 During the feature freeze all merge requests that are meant to go into the 152 upcoming release should have the correct milestone assigned _and_ the 153 `Pick into X.Y` label where `X.Y` is equal to the milestone, so that release 154 managers can find and pick them. 155 Merge requests without this label will not be picked into the stable release. 156 157 For example, if the upcoming release is `10.2.0` you will need to set the 158 `Pick into 10.2` label. 159 160 Fixes marked like this will be shipped in the next RC (before the 22nd), or the 161 next patch release. 162 163 If a merge request is to be picked into more than one release it will need one 164 `Pick into X.Y` label per release where the merge request should be back-ported 165 to. For example: 166 167 - `Pick into 10.1` 168 - `Pick into 10.0` 169 - `Pick into 9.5` 170 171 ### Asking for an exception 172 173 If you think a merge request should go into an RC or patch even though it does not meet these requirements, 174 you can ask for an exception to be made, by opening an isssue and 175 tagging the Release Manager. 176 177 To find out who the current Release Manager is find the latest release 178 checklist inside the issue tracker with the ~release label. For example 179 [this issues](https://gitlab.com/gitlab-org/gitlab-runner/issues/4333) 180 specifies that `@tmaczukin` is the release manager for 12.0. 181 182 ## Bugs 183 184 A ~bug is a defect, error, failure which causes the system to behave incorrectly or prevents it from fulfilling the product requirements. 185 186 The level of impact of a ~bug can vary from blocking a whole functionality 187 or a feature usability bug. A bug should always be linked to a severity level. 188 Refer to our [severity levels](https://docs.gitlab.com/ee/development/contributing/issue_workflow.html#severity-labels) 189 190 Whether the bug is also a regression or not, the triage process should start as soon as possible. 191 Ensure that the Engineering Manager and/or the Product Manager for the relative area is involved to prioritize the work as needed. 192 193 ### Regressions 194 195 A ~regression implies that a previously **verified working functionality** no longer works. 196 Regressions are a subset of bugs. We use the ~regression label to imply that the defect caused the functionality to regress. 197 The label tells us that something worked before and it needs extra attention from Engineering and Product Managers to schedule/reschedule. 198 199 The regression label does not apply to ~bugs for new features for which functionality was **never verified as working**. 200 These, by definition, are not regressions. 201 202 A regression should always have the `regression:xx.x` label on it to designate when it was introduced. 203 204 Regressions should be considered high priority issues that should be solved as soon as possible, especially if they have severe impact on users. 205 206 ### Managing bugs 207 208 **Prioritization:** We give higher priority to regressions on features that worked in the last recent monthly release and the current release candidates. 209 The two scenarios below can [bypass the exception request in the release process](https://gitlab.com/gitlab-org/release/docs/blob/master/general/exception-request/process.md#after-the-7th), where the affected regression version matches the current monthly release version: 210 211 - A regression which worked in the **Last monthly release** 212 - **Example:** In 11.0 we released a new `feature X` that is verified as working. Then in release 11.1 the feature no longer works, this is regression for 11.1. The issue should have the `regression:11.1` label. 213 - *Note:* When we say `the last recent monthly release`, this can refer to either the version currently running on GitLab.com, or the most recent version available in the package repositories. 214 - A regression which worked in the **Current release candidates** 215 - **Example:** In 11.1-RC3 we shipped a new feature which has been verified as working. Then in 11.1-RC5 the feature no longer works, this is regression for 11.1. The issue should have the `regression:11.1` label. 216 - *Note:* Because GitLab.com runs release candidates of new releases, a regression can be reported in a release before its 'official' release date on the 22nd of the month. 217 218 When a bug is found: 219 220 1. Create an issue describing the problem in the most detailed way possible. 221 1. If possible, provide links to real examples and how to reproduce the problem. 222 1. Label the issue properly, using the [team label](https://docs.gitlab.com/ee/development/contributing/issue_workflow.html#team-labels), 223 the [subject label](https://docs.gitlab.com/ee/development/contributing/issue_workflow.html#subject-labels) 224 and any other label that may apply in the specific case 225 1. Notify the respective Engineering Manager to evaluate and apply the [Severity label](https://docs.gitlab.com/ee/development/contributing/issue_workflow.html#severity-labels) and [Priority label](https://docs.gitlab.com/ee/development/contributing/issue_workflow.html#priority-labels). 226 The counterpart Product Manager is included to weigh-in on prioritization as needed. 227 1. If the ~bug is **NOT** a regression: 228 1. The Engineering Manager decides which milestone the bug will be fixed. The appropriate milestone is applied. 229 1. If the bug is a ~regression: 230 1. Determine the release that the regression affects and add the corresponding `regression:xx.x` label. 231 1. If the affected release version can't be determined, add the generic ~regression label for the time being. 232 1. If the affected version `xx.x` in `regression:xx.x` is the **current release**, it's recommended to schedule the fix for the current milestone. 233 1. This falls under regressions which worked in the last release and the current RCs. More detailed explanations in the **Prioritization** section above. 234 1. If the affected version `xx.x` in `regression:xx.x` is older than the **current release** 235 1. If the regression is an ~S1 severity, it's recommended to schedule the fix for the current milestone. We would like to fix the highest severity regression as soon as we can. 236 1. If the regression is an ~S2, ~S3 or ~S4 severity, the regression may be scheduled for later milestones at the discretion of the Engineering Manager and Product Manager. 237 238 ## Supported releases 239 240 The _last three releases_ are supported. Meaning if the latest version 241 is `11.11`, the supported versions are `11.11`, `11.10`, `11.9` 242 243 Each support requests for previous versions will be closed with 244 a ~wontfix label. 245 246 **What is supported?** 247 248 By the _release support_ we understand: 249 250 - fixes for security bugs 251 - fixes for other bugs 252 - requests for documentation 253 - questions of type _"How can I ...?"_ related to a supported version 254 255 Proposals for new features or improvements are welcome, but will be not 256 prepared for supported releases. Instead - if we decide to implement 257 them - they will be planned for one of the upcoming releases. 258 259 ## Releasing GitLab Runner 260 261 All the thecnincal details of how the Runner is released can be found in 262 the [Release 263 Checklist](https://gitlab.com/gitlab-org/ci-cd/runner-release-helper/tree/master/templates/issues) 264 which is split into multiple templates. 265 266 ## Copy & paste responses 267 268 ### Improperly formatted issue 269 270 ``` 271 Thanks for the issue report. Please reformat your issue to conform to the 272 [contributing guidelines](https://docs.gitlab.com/ee/development/contributing/issue_workflow.html#issue-tracker-guidelines). 273 ``` 274 275 ### Issue report for old version 276 277 ``` 278 Thanks for the issue report but we only support issues for the latest stable version of GitLab. 279 I'm closing this issue but if you still experience this problem in the latest stable version, 280 please open a new issue (but also reference the old issue(s)). 281 Make sure to also include the necessary debugging information conforming to the issue tracker 282 guidelines found in our [contributing guidelines](https://docs.gitlab.com/ee/development/contributing/issue_workflow.html#issue-tracker-guidelines). 283 ``` 284 285 ### Support requests and configuration questions 286 287 ``` 288 Thanks for your interest in GitLab. We don't use the issue tracker for support 289 requests and configuration questions. Please check our 290 [getting help](https://about.gitlab.com/getting-help/) page to see all of the available 291 support options. Also, have a look at the [contribution guidelines](https://docs.gitlab.com/ee/development/contributing/index.html) 292 for more information. 293 ``` 294 295 ### Code format 296 297 ``` 298 Please use \`\`\` to format console output, logs, and code as it's very hard to read otherwise. 299 ``` 300 301 ### Issue fixed in newer version 302 303 ``` 304 Thanks for the issue report. This issue has already been fixed in newer versions of GitLab. 305 Due to the size of this project and our limited resources we are only able to support the 306 latest stable release as outlined in our [contributing guidelines](https://docs.gitlab.com/ee/development/contributing/issue_workflow.html). 307 In order to get this bug fix and enjoy many new features please 308 [upgrade](https://gitlab.com/gitlab-org/gitlab-ce/tree/master/doc/update). 309 If you still experience issues at that time please open a new issue following our issue 310 tracker guidelines found in the [contributing guidelines](https://docs.gitlab.com/ee/development/contributing/issue_workflow.html#issue-tracker-guidelines). 311 ``` 312 313 ### Improperly formatted merge request 314 315 ``` 316 Thanks for your interest in improving the GitLab codebase! 317 Please update your merge request according to the [contributing guidelines](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/development/contributing/merge_request_workflow.md#merge-request-guidelines). 318 ``` 319 320 ### Accepting merge requests 321 322 ``` 323 Is there an issue on the 324 [issue tracker](https://gitlab.com/gitlab-org/gitlab-ce/issues) that is 325 similar to this? Could you please link it here? 326 Please be aware that new functionality that is not marked 327 [`Accepting merge requests`](https://docs.gitlab.com/ee/development/contributing/issue_workflow.html#label-for-community-contributors) 328 might not make it into GitLab. 329 ``` 330 331 ### Only accepting merge requests with green tests 332 333 ``` 334 We can only accept a merge request if all the tests are green. I've just 335 restarted the build. When the tests are still not passing after this restart and 336 you're sure that is does not have anything to do with your code changes, please 337 rebase with master to see if that solves the issue. 338 ```