opendev/system-config
Code Issues Proposed changes

Update and clarify StackForge documentation.

Browse Source 
* doc/source/stackforge.rst: Release tagging seems to be a FAQ
amongst StackForge projects, so I've added core tag permissions to
the example. Setting the project active is unnecessary since that's
the default anyway. The acl-config parameter in project
configuration is no longer needed unless it differs from the normal
file location/name. Also added some further clarification and
explanations for the ACL example.

Change-Id: Id97d9fdf9e99e2948a83aea90c292d63b4c1e4d1
Reviewed-on: https://review.openstack.org/25005
Reviewed-by: Khai Do <zaro0508@gmail.com>
Reviewed-by: James E. Blair <corvus@inaugust.com>
Approved: James E. Blair <corvus@inaugust.com>
Tested-by: Jenkins
This commit is contained in:
Jeremy Stanley 2013-03-21 15:14:58 +00:00 committed by Jenkins
parent 827b59ec82
commit c260d76408
1 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/source/stackforge.rst
View File

@ -55,14 +55,13 @@ look something like::
- project: stackforge/project-name
description: Latest and greatest cloud stuff.
acl-config: /home/gerrit2/acls/stackforge/project-name.config
upstream: git://github.com/awesumsauce/project-name.git
The description will set the project description on the GitHub
StackForge mirror, and the upstream should point at an existing
repository that should be used to preseed Gerrit. Both of these options
are optional, but you must have an acl-config. Note that the current
tools assume that the upstream repo will have a master branch.
repository which can be used to preseed Gerrit with an initial commit
history. Both of these are optional. Note that the current tools
assume that the upstream repo will have a master branch.
The next step is to add a Gerrit ACL config file. Edit
``openstack-infra/config/modules/openstack_project/files/gerrit/acls/stackforge/project-name.config``
@ -72,14 +71,25 @@ and make it look like::
label-Code-Review = -2..+2 group project-name-core
label-Approved = +0..+1 group project-name-core
workInProgress = group project-name-core
[project]
state = active
[access "refs/tags/*"]
create = group project-name-core
pushTag = group project-name-core
[receive]
requireChangeId = true
requireContributorAgreement = true
[submit]
mergeContent = true
The access sections in the example ACL grant the project's core group
approval privileges and the ability so set/un-set WIP status on
changes, as well as the ability to push tags. The other sections set
some required options for Gerrit to function normally (enforcing
presence of a Change-Id in commits and allowing changes to be merged).
This example also expects contributors to agree to a standard
OpenStack CLA, join the OpenStack Foundation and submit contact
information (this feature can be disabled by setting
requireContributorAgreement to false).
That is all that is necessary to add a StackForge project to Gerrit;
however, this project isn't very useful until we setup Jenkins jobs for
it and configure Zuul to run those jobs. Continue reading to configure