From 50fd118ef2b9e0213d1549e470b10eba0286545d Mon Sep 17 00:00:00 2001
From: Ian Wienand <iwienand@redhat.com>
Date: Wed, 25 Oct 2017 08:39:10 +1100
Subject: [PATCH] Add some notes on eol_branch.sh

Change-Id: Ib5e02ce4dd72a7fa472a592bbe8103a2aa9e3627
---
 README.rst | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/README.rst b/README.rst
index d4544a0..71110e4 100644
--- a/README.rst
+++ b/README.rst
@@ -867,3 +867,29 @@ Example::
   ./bugs-fixed-since.py [...] --start=8.0.0 | ./lp-tag.py foo-tag
 
 This command will add the 'foo-tag' tag to all bugs fixed since 8.0.0.
+
+End of Life
+===========
+
+The ``eol_branch.sh`` script is provided to end-of-life branches.  It
+will abandon any changes on the to-be-removed branch, create a
+``branch-eol`` tag at the current branch ``HEAD`` and then remove the
+branch.
+
+To run the script, add yourself to "Project Bootstrappers" temporarily
+in ``review.openstack.org``.
+
+Usually the release or stable team will have provided the branches to remove
+grouped by project in an easy to use format.  The command goes
+something like::
+
+  eol_branch.sh -- stable/oldbranch oldbranch-eol openstack/project1 openstack/python-project1
+
+gpg tips
+--------
+
+Tags will be signed, so ensure ``gpg`` is setup correctly.  ``gpg2``
+has better support for ``gpg-agent``, so ``git config --global
+gpg.program gpg2`` will probably just "do the right thing" (note if
+you're migrating, you may need to import your keys with
+``gpg2 --import < ~/.gnupg/secreing.gpg``).