<p>George Joseph <strong>merged</strong> this change.</p><p><a href="https://gerrit.asterisk.org/c/asterisk/+/11197">View Change</a></p><div style="white-space:pre-wrap">Approvals:
  Friendly Automation: Verified
  George Joseph: Looks good to me, approved; Approved for Submit

</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">build: Add staging directories for future changes.<br><br>This is the first step in changing the release process so that changes<br>made to the CHANGES and UPGRADE.txt files do not result in merge<br>conflicts every time multiple people modify these files. The changes<br>made will go in these new directories: doc/CHANGES-staging and<br>doc/UPGRADE-staging. The README.md files explain how things will work,<br>but here's a little overview. When you make a change that would go in<br>either CHANGES or UPGRADE.txt, this should instead be documented in a<br>new file in the doc/CHANGES-staging or doc/UPGRADE-staging directory,<br>respectively. The format will look like this:<br><br>   Subject: res_pjsip<br><br>   A description that explains the changes made and why. The release<br>   script will handle the bulleting and section separators! The<br>   'Subject:' header is case-sensitive.<br><br>   You can still separate with new lines within your description.<br><br>   Subject: res_ari<br>   Master-Only: true<br><br>   You can have more than one subject, and they don't have to be the<br>   same! Also, the 'Master-Only' header should always be true and is<br>   also case-sensitive (but the value is not - you can have 'true' or<br>   'True'). This header will only ever be present in the master branch.<br><br>For more information, check out the wiki page:<br>https://wiki.asterisk.org/wiki/display/AST/CHANGES+and+UPGRADE.txt<br><br>This is an initial change for ASTERISK_28111. Functionally, this will<br>make no difference, but it will prep the directories for when the<br>changes from CHANGES and UPGRADE.txt are extracted.<br><br>Change-Id: I8d852f284f66ac456b26dcb899ee46babf7d15b6<br>---<br>A doc/CHANGES-staging/README.md<br>A doc/UPGRADE-staging/README.md<br>2 files changed, 65 insertions(+), 0 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/doc/CHANGES-staging/README.md b/doc/CHANGES-staging/README.md</span><br><span>new file mode 100644</span><br><span>index 0000000..da0df2a</span><br><span>--- /dev/null</span><br><span>+++ b/doc/CHANGES-staging/README.md</span><br><span>@@ -0,0 +1,33 @@</span><br><span style="color: hsl(120, 100%, 40%);">+## **DO NOT REMOVE THIS FILE!**</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The only files that should be added to this directory are ones that will be</span><br><span style="color: hsl(120, 100%, 40%);">+used by the release script to update the CHANGES file automatically. The only</span><br><span style="color: hsl(120, 100%, 40%);">+time that it is necessary to add something to the CHANGES-staging directory is</span><br><span style="color: hsl(120, 100%, 40%);">+if you are either adding a new feature to Asterisk or adding new functionality</span><br><span style="color: hsl(120, 100%, 40%);">+to an existing feature. The file does not need to have a meaningful name, but</span><br><span style="color: hsl(120, 100%, 40%);">+it probably should. If there are multiple items that need documenting, each can</span><br><span style="color: hsl(120, 100%, 40%);">+be separated with a subject line, which should always start with "Subject:",</span><br><span style="color: hsl(120, 100%, 40%);">+followed by the subject of the change. This is case sensitive! For example, if</span><br><span style="color: hsl(120, 100%, 40%);">+you are making a change to PJSIP, then you might add the file</span><br><span style="color: hsl(120, 100%, 40%);">+"res_pjsip_my_cool_feature" to this directory, with a short description of what</span><br><span style="color: hsl(120, 100%, 40%);">+it does. If you are adding multiple entries, they should be done in the same</span><br><span style="color: hsl(120, 100%, 40%);">+commit to avoid merge conflicts. Here's an example:</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+> Subject: res_pjsip</span><br><span style="color: hsl(120, 100%, 40%);">+></span><br><span style="color: hsl(120, 100%, 40%);">+> Here's a pretty good description of my new feature that explains exactly what</span><br><span style="color: hsl(120, 100%, 40%);">+> it does and how to use it.</span><br><span style="color: hsl(120, 100%, 40%);">+></span><br><span style="color: hsl(120, 100%, 40%);">+> Subject: core</span><br><span style="color: hsl(120, 100%, 40%);">+> Master-Only: true</span><br><span style="color: hsl(120, 100%, 40%);">+></span><br><span style="color: hsl(120, 100%, 40%);">+> Here's another description of something else I added that is a big enough</span><br><span style="color: hsl(120, 100%, 40%);">+> change to warrant another entry in the CHANGES file.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Note that the second subject has another header: "Master-Only". Changes that go</span><br><span style="color: hsl(120, 100%, 40%);">+into the master branch and ONLY the master branch are the only ones that should</span><br><span style="color: hsl(120, 100%, 40%);">+have this header. Also, the value can only be "true" or "True". The</span><br><span style="color: hsl(120, 100%, 40%);">+"Master-Only" part of the header IS case-sensitive, however!</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+For more information, check out the wiki page:</span><br><span style="color: hsl(120, 100%, 40%);">+https://wiki.asterisk.org/wiki/display/AST/CHANGES+and+UPGRADE.txt</span><br><span>diff --git a/doc/UPGRADE-staging/README.md b/doc/UPGRADE-staging/README.md</span><br><span>new file mode 100644</span><br><span>index 0000000..1ef9334</span><br><span>--- /dev/null</span><br><span>+++ b/doc/UPGRADE-staging/README.md</span><br><span>@@ -0,0 +1,32 @@</span><br><span style="color: hsl(120, 100%, 40%);">+## **DO NOT REMOVE THIS FILE!**</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The only files that should be added to this directory are ones that will be</span><br><span style="color: hsl(120, 100%, 40%);">+used by the release script to update the UPGRADE.txt file automatically. The</span><br><span style="color: hsl(120, 100%, 40%);">+only time that it is necessary to add something to the UPGRADE-staging directory</span><br><span style="color: hsl(120, 100%, 40%);">+is if you are making a breaking change to an existing feature in Asterisk. The</span><br><span style="color: hsl(120, 100%, 40%);">+file does not need to have a meaningful name, but it probably should. If there</span><br><span style="color: hsl(120, 100%, 40%);">+are multiple items that need documenting, each can be separated with a subject</span><br><span style="color: hsl(120, 100%, 40%);">+line, which should always start with "Subject:", followed by the subject of the</span><br><span style="color: hsl(120, 100%, 40%);">+change. This is case sensitive! For example, if you are making a change to PJSIP,</span><br><span style="color: hsl(120, 100%, 40%);">+then you might add the file "res_pjsip_breaking_change" to this directory, with</span><br><span style="color: hsl(120, 100%, 40%);">+a short description of what it does. If you are adding multiple entries, they</span><br><span style="color: hsl(120, 100%, 40%);">+should be done in the same commit to avoid merge conflicts. Here's an example:</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+> Subject: res_pjsip</span><br><span style="color: hsl(120, 100%, 40%);">+></span><br><span style="color: hsl(120, 100%, 40%);">+> Here's a pretty good description of what I changed that explains exactly what</span><br><span style="color: hsl(120, 100%, 40%);">+> it does and why it breaks things (and why they needed to be broken).</span><br><span style="color: hsl(120, 100%, 40%);">+></span><br><span style="color: hsl(120, 100%, 40%);">+> Subject: core</span><br><span style="color: hsl(120, 100%, 40%);">+> Master-Only: true</span><br><span style="color: hsl(120, 100%, 40%);">+></span><br><span style="color: hsl(120, 100%, 40%);">+> Here's another description of something else I added that is a big enough</span><br><span style="color: hsl(120, 100%, 40%);">+> change to warrant another entry in the UPDATE.txt file.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Note that the second subject has another header: "Master-Only". Changes that go</span><br><span style="color: hsl(120, 100%, 40%);">+into the master branch and ONLY the master branch are the only ones that should</span><br><span style="color: hsl(120, 100%, 40%);">+have this header. Also, the value can only be "true" or "True". The</span><br><span style="color: hsl(120, 100%, 40%);">+"Master-Only" part of the header IS case-sensitive, however!</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+For more information, check out the wiki page:</span><br><span style="color: hsl(120, 100%, 40%);">+https://wiki.asterisk.org/wiki/display/AST/CHANGES+and+UPGRADE.txt</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.asterisk.org/c/asterisk/+/11197">change 11197</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.asterisk.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.asterisk.org/c/asterisk/+/11197"/><meta itemprop="name" content="View Change"/></div></div>

<div style="display:none"> Gerrit-Project: asterisk </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: I8d852f284f66ac456b26dcb899ee46babf7d15b6 </div>
<div style="display:none"> Gerrit-Change-Number: 11197 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: Benjamin Keith Ford <bford@digium.com> </div>
<div style="display:none"> Gerrit-Reviewer: Friendly Automation </div>
<div style="display:none"> Gerrit-Reviewer: George Joseph <gjoseph@digium.com> </div>
<div style="display:none"> Gerrit-MessageType: merged </div>