Browse Source

Add project-config reviewing guidelines

As discussed at the OpenStack summit [1], document a few guidelines on
reviewing project-config changes.

The list is not exhaustive.

[1]
https://etherpad.openstack.org/p/newton-infra-proposal-jobs

Change-Id: I894782f0d7e69bc5385b30a940e21cfb49dcbe08
tags/before-jenkins-config-removed
Andreas Jaeger 3 years ago
parent
commit
f204a7cac6
1 changed files with 68 additions and 0 deletions
  1. 68
    0
      REVIEWING.rst

+ 68
- 0
REVIEWING.rst View File

@@ -0,0 +1,68 @@
1
+========================
2
+Reviewing project-config
3
+========================
4
+
5
+The following are notes for reviewers on how to review changes for
6
+project-config. These notes are not exhaustive, they cover a few
7
+caveats that especially core reviewers should be aware of.
8
+
9
+Additional reviews
10
+==================
11
+
12
+For changes to projects, there should be support by the project team
13
+that is affected. A couple of projects have listed infra liasons at
14
+https://wiki.openstack.org/wiki/CrossProjectLiaisons#Infra . Changes
15
+should only merge when at least one of the infra liasons has given a
16
++1. For not-listed projects, there are no rules but it might be good
17
+to ask for review by PTL or cores of the repo depending on the change.
18
+
19
+Voting jobs
20
+===========
21
+
22
+There should be no non-voting jobs in the gate queue. Voting jobs
23
+should be in both check and gate queues.
24
+
25
+New repo creations
26
+==================
27
+
28
+Check the following:
29
+
30
+* If publishing to PyPI is set up: Check that
31
+  https://pypi.python.org/pypi/PROJECT exists and is set up for
32
+  openstackci.
33
+
34
+* Is this a new repository for a team that is part of the Big Tent?
35
+  Then ask for a governance review and PTL+1.
36
+
37
+* If there's no import ("upstream" keyword) of an existing repository,
38
+  best check that the team really wants to start with a new empty repo
39
+  and has no content to import. Either is fine, it's just that an
40
+  import at repo creation time is easy, afterwards it only causes
41
+  problems.
42
+
43
+Big Tent resources
44
+==================
45
+
46
+Check that publishing to docs.openstack.org or specs.openstack.org is
47
+only enabled for projects that are in the Big Tent (mentioned in
48
+governance repository). Similary, translation workflow is also only
49
+enabled for Big Tent projects.
50
+
51
+Proposal jobs
52
+=============
53
+
54
+Proposal jobs run on the long running proposal slave that has access
55
+to the credentials that the jobs need to access Zanata and gerrit.
56
+Jobs running there are the exception and need to be carefully reviewed
57
+before approving them.
58
+
59
+Here are some points to look at:
60
+
61
+* First response should be: How else can we achieve this?
62
+
63
+* Jobs can publish artifacts also to specific places, like
64
+  static.openstack.org or tarballs.openstack.org, and use these from
65
+  other jobs.
66
+
67
+* Proposal jobs should not run arbitrary scripts from other
68
+  repositories or install untrusted packages.

Loading…
Cancel
Save