add note to run git review -s before deleting repo

to ensure clarity, add a note that indicates to run
`git review -s` before proposing the repo is deleted.

without the change users may get hung up on trying
to push the change, or may avoid deleting .gitreview.

Change-Id: Ie7bc2c3c661110588275e8d5e4a0044822ea884b
This commit is contained in:
Steve Martinelli 2016-12-30 14:27:58 -05:00
parent 258aa9ac5d
commit 8deef8dcdc
1 changed files with 7 additions and 1 deletions

View File

@ -428,7 +428,8 @@ Remove Project Content
Once Zuul is no longer running tests on your project, prepare a change
that removes all of the files from your project except the README.
Double check that all dot files are also removed.
Double check that all dot files (such as ``.gitignore``, ``.testr.conf``,
and ``.gitreview``) are also removed.
Replace the contents of the README with a message such as this::
@ -449,6 +450,11 @@ Replace the contents of the README with a message such as this::
Merge this commit to your project.
.. note::
Before removing ``.gitreview`` be sure to run ``git review -s``, this
will record the necessary information about the repository.
If any users missed the announcement that the project is being
retired, removing the content of the repository will cause any users
who continuously deploy the software as well as users who track