build: Revise CHANGES and UPGRADE.txt handling.
authorBen Ford <bford@digium.com>
Mon, 1 Apr 2019 20:38:04 +0000 (15:38 -0500)
committerBen Ford <bford@digium.com>
Tue, 9 Apr 2019 14:45:04 +0000 (09:45 -0500)
commita4ab7f5f80b6c29f81f0de3f58f1f7a4b398c6d3
tree60da0cb93e0e9b6dd004dc4919f51437e1129ba9
parente8cf3693f6274c28039956b4d0fbad14984571ad
build: Revise CHANGES and UPGRADE.txt handling.

This changes the way that we handle adding changes to CHANGES and
UPGRADE.txt. The reason for this is because whenever someone needed to
make a change to one of these files and someone else had already done
so, you would run into merge conflicts. With this new setup, there will
never be merge conflicts since all changes will be documented in the
doc/<file>-staging directory. The release script is now responsible for
merging all of these changes into the appropriate files.

There is a special format that these files have to follow in order to be
parsed. The files do not need to have a meaningful name, but it is
strongly recommended. For example, if you made a change to pjsip, you
may have something like this "res_pjsip_relative_title", where
"relative_title" is something more descriptive than that. Inside each
file, you will need a subject line for your change, followed by a
description. There can be multiple subject lines. The file may look
something like this:

   Subject: res_pjsip
   Subject: Core

   A description that explains the changes made and why. The release
   script will handle the bulleting and section separators!

   You can still separate with new lines within your
   description.

The headers ("Subject" and "Master-Only") are case sensative, but the
value for "Master-Only" ("true" or "True") is not.

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

ASTERISK-28111 #close

Change-Id: I19cf4b569321c88155a65e9b0b80f6d58075dd47
25 files changed:
CHANGES
UPGRADE-1.2.txt [deleted file]
UPGRADE-1.4.txt [deleted file]
UPGRADE-1.6.txt [deleted file]
UPGRADE-1.8.txt [deleted file]
UPGRADE-10.txt [deleted file]
UPGRADE-11.txt [deleted file]
UPGRADE-12.txt [deleted file]
UPGRADE-13.txt [deleted file]
UPGRADE-14.txt [deleted file]
UPGRADE-15.txt [deleted file]
UPGRADE-16.txt [deleted file]
UPGRADE.txt
doc/CHANGES-staging/README.md
doc/CHANGES-staging/bridging_stasis_cache.txt [new file with mode: 0644]
doc/CHANGES-staging/chan_sip_deprecated.txt [new file with mode: 0644]
doc/CHANGES-staging/channels_stasis_cache.txt [new file with mode: 0644]
doc/UPGRADE-staging/README.md
doc/UPGRADE-staging/applications_jabberstatus.txt [new file with mode: 0644]
doc/UPGRADE-staging/bridging_stasis_cache.txt [new file with mode: 0644]
doc/UPGRADE-staging/chan_sip_deprecated.txt [new file with mode: 0644]
doc/UPGRADE-staging/channels_stasis_cache.txt [new file with mode: 0644]
doc/UPGRADE-staging/func_callerid_callerpres.txt [new file with mode: 0644]
doc/UPGRADE-staging/res_parking_parkingslot.txt [new file with mode: 0644]
doc/UPGRADE-staging/res_xmpp_jabberstatus.txt [new file with mode: 0644]