[Asterisk-code-review] build: Improve handling of CHANGES and UPGRADE.txt for relea... (repotools[master])

Benjamin Keith Ford asteriskteam at digium.com
Fri Feb 1 11:47:34 CST 2019


Benjamin Keith Ford has uploaded a new patch set (#2). ( https://gerrit.asterisk.org/10941 )

Change subject: build: Improve handling of CHANGES and UPGRADE.txt for releases.
......................................................................

build: Improve handling of CHANGES and UPGRADE.txt for releases.

The release script now handles the merging of the CHANGES and
UPGRADE.txt files for us! When a release is being done, the script will
go through the staging changes in the Asterisk working directory
(<asterisk-home>/doc/<file>-staging) and add each change to the
corresponding file. A separate script (process-staging-changes) has also
been added that can be used when creating a new version from master. It
takes 3 arguments: -l/--local-root, which is optional,
-s/--start-version, and -e/--end-version. You can use -h for more
information on each option.

This means that there's a new way to document our major changes. All
changes for CHANGES will go into doc/CHANGES-staging and all changes for
UPGRADE.txt will go into doc/UPGRADE-staging. Each of these files should
have a meaningful name related to what the change is. For example, if
you made a change to something in pjsip, your file might be called
"res_pjsip_relative_title", where "relative_title" will be something a
little more descriptive than that. Inside of each file, you will have a
subject line followed by a blank line, with the description of the
change following that. You can have multiple subject lines in one file.
For example, it may look something like this:

   Subject: res_pjsip

   This is a detailed description of what I changed.

   You can have new lines in between as well, spacing is handled by the
   release script!

   Subject: res_pjsip

   You can have another subject as well!

   Subject: Core

   The subjects don't have to be the same either!

The header lines (Subject:) are case sensative.

Fore more information, check out the wiki page:
https://wiki.asterisk.org/wiki/display/AST/CHANGES+and+UPGRADE.txt

Change-Id: I6dc084afedaeecaf36aaec66c3cf6a5a8ed4ef3c
---
M mkrelease.py
A process-staging-changes
A staging_changes.py
3 files changed, 227 insertions(+), 0 deletions(-)


  git pull ssh://gerrit.asterisk.org:29418/repotools refs/changes/41/10941/2
-- 
To view, visit https://gerrit.asterisk.org/10941
To unsubscribe, or for help writing mail filters, visit https://gerrit.asterisk.org/settings

Gerrit-Project: repotools
Gerrit-Branch: master
Gerrit-MessageType: newpatchset
Gerrit-Change-Id: I6dc084afedaeecaf36aaec66c3cf6a5a8ed4ef3c
Gerrit-Change-Number: 10941
Gerrit-PatchSet: 2
Gerrit-Owner: Benjamin Keith Ford <bford at digium.com>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-code-review/attachments/20190201/7bfe1d1f/attachment.html>


More information about the asterisk-code-review mailing list