Merge pull request #1410 from rpspringuel/ctan

CTAN related fixes/upgrades

Author: rpspringuel

CHANGELOG.md

@@ -23,7 +23,7 @@ As of v3.0.0 this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [5.0.1] - 2017-04-16
 ### Fixed
-- Fixed a bug in the TeXLive compatibility code for Windows users.  Thanks to Akira Kakuto for the catch.
+- Fixed a bug in the TeX Live compatibility code for Windows users.  Thanks to Akira Kakuto for the catch.
 
 ## [5.0.0] - 2017-04-15
 ### Fixed
@@ -81,7 +81,7 @@ As of v3.0.0 this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [4.2.1][Unreleased]
 ### Fixed
-- Debian build scripts now use directories compatible with the TeXLive 2016 packaging of Gregorio (see [#1241](https://github.com/gregorio-project/gregorio/issues/1241)).
+- Debian build scripts now use directories compatible with the TeX Live 2016 packaging of Gregorio (see [#1241](https://github.com/gregorio-project/gregorio/issues/1241)).
 
 
 ## [4.2.0] - 2016-09-23
@@ -175,7 +175,7 @@ As of v3.0.0 this project adheres to [Semantic Versioning](http://semver.org/).
 ## [4.1.2] - 2016-05-08
 ### Changed
 - The parmesan font is now called granapadano.  If you were using `\gresetgregoriofont{parmesan}`, you should now use `\gresetgregoriofont{granapadano}`.  See [#1075](https://github.com/gregorio-project/gregorio/issues/1075).
-- GregorioTeX is now compatible with TeXLive 2016
+- GregorioTeX is now compatible with TeX Live 2016
 
 
 ## [4.1.1] - 2016-03-10
@@ -216,7 +216,7 @@ As of v3.0.0 this project adheres to [Semantic Versioning](http://semver.org/).
 - Command line output (help message, version message, error handling) has been improved, see [#891](https://github.com/gregorio-project/gregorio/issues/891)
 - Windows installer no longer copies the executable into the TeX bin directory.  Instead it has the option to add its own bin directory to PATH.
 - `system-setup.sh` has become `system-setup.command` so that it is double click executable on Mac.
-- Post install options for Windows installer have been simplified.  There are no longer separate options for MiKTeX and TeXLive.  Instead the installer will determine which you have itself and act accordingly.
+- Post install options for Windows installer have been simplified.  There are no longer separate options for MiKTeX and TeX Live.  Instead the installer will determine which you have itself and act accordingly.
 - Windows installer will check more locations for old installations to remove.
 - Height of the porrectus have been altered (first note moved up, second also moved up when second ambitus is more than one) so that they are more coherent with the punctum height. The porrectus stroke drawings have also been slightly altered to be slightly thinner and sharper around the bottom note (see [#858](https://github.com/gregorio-project/gregorio/issues/858)).
 - When a syllable is preceeded by a punctum mora, gregorio now ignores the punctum mora in the spacing of the syllables by default, and also adds a custom space (defaulting to 0). You can change this behavior with `\gresetshiftaftermora{}`, see GregorioRef for its arguments. To balance the output, space before a punctum mora has been made slightly thinner, more in line with old Solesmes books. (For the change requests, see [#795](https://github.com/gregorio-project/gregorio/issues/795) and [#871](https://github.com/gregorio-project/gregorio/issues/871)).
@@ -363,7 +363,7 @@ As of v3.0.0 this project adheres to [Semantic Versioning](http://semver.org/).
 - The spacing of manual in-line custos (`(f+)` in gabc) is now consistent with the spacing of automatic in-line custos (`(z0)` in gabc).  See [#642](https://github.com/gregorio-project/gregorio/issues/642).
 - Signs on the climacus praepunctis deminutus `(ghgf~)` neume are now positioned correctly.  See [#650](https://github.com/gregorio-project/gregorio/issues/650)
 - Mac installer has been made SIP compliant (i.e. it now works on El Capitan).
-- Mac installer can now detect installations of TeXLive done with MacPorts or the command-line tool provided by TUG.
+- Mac installer can now detect installations of TeX Live done with MacPorts or the command-line tool provided by TUG.
 - Windows executable has file version information attached correctly so that the installer can properly recognize and replace the binary during an upgrade process.
 - Spacing was too large when alteration begins a syllable, see [#663](https://github.com/gregorio-project/gregorio/issues/663).
 
@@ -424,7 +424,7 @@ As of v3.0.0 this project adheres to [Semantic Versioning](http://semver.org/).
   - `\gredefsymbol` for (re-)defining an arbitrary non-score glyph that scales with the text
   - `\gredefsizedsymbol` for (re-)defining an arbitary non-score glyph that requires a point-size to be specified.
 See GregorioRef.pdf for full details.
-- Added `--with-kpathsea` option to configure script, to check input and output file against `openout_any` and `openin_any` settings of texmf.cnf (TeXLive only). Necessary to be included in `shell_escape_commands` in TeXLive.
+- Added `--with-kpathsea` option to configure script, to check input and output file against `openout_any` and `openin_any` settings of texmf.cnf (TeX Live only). Necessary to be included in `shell_escape_commands` in TeX Live.
 - Support for `lualatex -recorder`.  Autocompiled gabc and gtex files will now be properly recorded so that programs like `latexmk -recorder` can detect the need to rebuild the PDF when a gabc file changes.
 - A vertical episema may now be forced to appear above or below a note.  In gabc, use `'0` for the vertical episema to appear below and `'1` for the vertical episema to appear above (see [#385](https://github.com/gregorio-project/gregorio/issues/385)).
 - The first word, first syllable, and first letter of the first syllable that is *not* interpreted as the initial of the score can now be styled from TeX.  Use `\grechangestyle` to modify the `firstsyllableinitial`, `firstsyllable`, and `firstword` as desired.

Makefile.am

@@ -23,6 +23,8 @@ EXTRA_DIST = README.md CHANGELOG.md CONTRIBUTING.md CONTRIBUTORS.md \
 			 UPGRADE.md COPYING.md .gregorio-version VersionManager.py \
 			 build.sh install.sh install-gtex.sh
 
+MAINTAINERCLEANFILES = gregoriotex.ctan.zip
+
 export TOP_LEVEL_MAKE = true
 
 gregorio:

README.md

@@ -14,11 +14,11 @@ You can also try it online [here](http://dev.illuminarepublications.com/gregorio
 
 ## Installation
 
-You need a recent and working [TeXLive](https://www.tug.org/texlive/), on top of which you just need to install latest [Gregorio release](https://github.com/gregorio-project/gregorio/releases). See [the website](http://gregorio-project.github.io/installation.html) for more details.
+You need a recent and working [TeX Live](https://www.tug.org/texlive/), on top of which you just need to install latest [Gregorio release](https://github.com/gregorio-project/gregorio/releases). See [the website](http://gregorio-project.github.io/installation.html) for more details.
 
-## Building for inclusion in TeXLive
+## Building for inclusion in TeX Live
 
-When building gregorio for inclusion in TeXLive, the gregorio executable must not have the version number suffix that is used for other builds.  To make this happen, run `configure` with the `--disable-version-in-exe` option, and the generated Makefile will create a gregorio executable without the version number suffix (i.e., the executable will simply be named `gregorio`).
+When building gregorio for inclusion in TeX Live, the gregorio executable must not have the version number suffix that is used for other builds.  To make this happen, run `configure` with the `--disable-version-in-exe` option, and the generated Makefile will create a gregorio executable without the version number suffix (i.e., the executable will simply be named `gregorio`).
 
 ## Documentation
 

UPGRADE.md

@@ -1,6 +1,10 @@
 # Upgrade Manual
 
-This file contains instructions to upgrade to a new release of Gregorio.
+This file contains instructions to upgrade to a new release of Gregorio.  These instructions are cumulative; meaning that you should apply the instructions from all versions between the one you are upgrading from and the current version.
+
+## 5.1
+
+No additional steps are needed to upgrade from 5.0 to 5.1.
 
 ## 5.0
 
@@ -18,7 +22,7 @@ To install the new versions of Gregorio (the font) and Grana Padano, unzip `supp
  * `system`: the appropriate font folder in `$TEXMFLOCAL`
  * `user`: the appropriate font folder in `$TEXMFHOME`
  * `<dir>`: the name of an alternate texmf root directory you want to use
- 
+
 Additionally, if you are building the fonts yourself from a git clone, `install-gtex.sh` and `install_supp_fonts.lua` will install all the fonts you have built, not just the ones they are normally distributed with.
 
 **Note:** All the above methods assume you only need to access the fonts from within a TeX document (and thus are designed to put them into the correct folder in a texmf tree).  If you want to use the fonts in other programs, then you will need to consult the documentation appropriate to your platform and/or the program and manually move, copy, or link the fonts to the necessary location.
@@ -27,7 +31,7 @@ Additionally, if you are building the fonts yourself from a git clone, `install-
 
 As of version 5.0, ledger lines are extended through notes on either side of a ledger line that crosses a stem, as long as the notes are within the same element.
 
-The algorithm for this is simple so it can be predictable, and it cannot take into account spacing adjustments made it TeX.  This means it may not produce the exactly desired results.  In order to get the results you want, you can override the automatic behavior in gabc:
+The algorithm for this is simple so it can be predictable, and it cannot take into account spacing adjustments made in TeX.  This means it may not produce the exactly desired results.  In order to get the results you want, you can override the automatic behavior in gabc:
 
 - `[oll:1]` will force an over-the-staff ledger line on a note.
 - `[oll:0]` will suppress an over-the-staff ledger line on a note.
@@ -113,7 +117,7 @@ Prior to version 4.2, Gregorio inconsistenly indicated style errors.  Now, error
 
 ### Changes to texmf tree
 
-To better comply with the TeXLive directory structure, the location of `gregoriotex.sty` and `gregoriosyms.sty` have changed.
+To better comply with the TeX Live directory structure, the location of `gregoriotex.sty` and `gregoriosyms.sty` have changed.
 
 *Linux and other users installing from source:* `install-gtex.sh` should remove the old versions before installing the new one.
 
@@ -136,7 +140,7 @@ High notes are now taken into account in vertical spacings. If you would like to
 
 ### Last line of score behavior
 
-`\grelooseness` is now `-1` by default. This should prevent orphaned syllable at end of score. If you prefer the old behavior, use `\def\grelooseness{\looseness}` befor including your scores.
+`\grelooseness` is now `-1` by default. This should prevent orphaned syllable at end of score. If you prefer the old behavior, use `\def\grelooseness{\looseness}` before including your scores.
 
 ## 4.1
 

VersionManager.py

@@ -222,20 +222,48 @@ def replace_version(version_obj):
                     result.append(line)
         with open(myfile, 'w') as outfile:
             outfile.write(''.join(result))
+    sys.exit(0)
+
+def update_changelog(newver,upgradetype):
+    today = date.today()
     with open('CHANGELOG.md', 'r') as infile:
         result = []
+        develop = False
         for line in infile:
-            if '[Unreleased][unreleased]' in line:
-                result.append(line)
-                result.append('\n')
-                result.append('\n')
-                newline = '## [' + newver + '] - ' + today.strftime("%Y-%m-%d") + '\n'
-                result.append(newline)
+            if upgradetype == "patch":
+                if '[Unreleased][develop]' in line:
+                    print("Found an unreleased develop section.")
+                    print("Patch releases should be based on ctan branch.")
+                    sys.exit(1)
+                if '[Unreleased][CTAN]' in line:
+                    result.append(line)
+                    result.append('\n')
+                    result.append('\n')
+                    newline = '## [' + newver + '] - ' + today.strftime("%Y-%m-%d") + '\n'
+                    result.append(newline)
+                else:
+                    result.append(line)
             else:
-                result.append(line)
+                if '[Unreleased][develop]' in line:
+                    develop = True
+                    result.append(line)
+                    result.append('\n')
+                    result.append('\n')
+                    result.append('## [Unreleased][CTAN]\n')
+                    result.append('\n')
+                    result.append('\n')
+                    newline = '## [' + newver + '] - ' + today.strftime("%Y-%m-%d") + '\n'
+                    result.append(newline)
+                elif '[Unreleased][CTAN]' in line and develop:
+                    continue
+                else:
+                    result.append(line)
+        if not develop and upgradetype != "patch":
+            print("I didn't find a unreleased develop section.")
+            print("Non-patch releases should be based on develop branch.")
+            sys.exit(1)
     with open('CHANGELOG.md','w') as outfile:
         outfile.write(''.join(result))
-    sys.exit(0)
 
 def confirm_replace(oldver, newver):
     "Query the user to confirm action"
@@ -262,6 +290,7 @@ def release_candidate(version_obj, not_interactive):
         newversion = re.sub(r'-.*', '-rc1', oldversion)
     if (not not_interactive):
         confirm_replace(oldversion, newversion)
+    update_changelog(newversion,"releasecandidate")
     version_obj.update_version(newversion)
     replace_version(version_obj)
 
@@ -277,6 +306,7 @@ def beta(version_obj, not_interactive):
         sys.exit(1)
     if (not not_interactive):
         confirm_replace(oldversion, newversion)
+    update_changelog(newversion,"beta")
     version_obj.update_version(newversion)
     replace_version(version_obj)
 
@@ -287,6 +317,7 @@ def bump_major(version_obj, not_interactive):
     newversion = str(int(nums.group(1)) +1) + '.0.0-beta1'
     if (not not_interactive):
         confirm_replace(oldversion, newversion)
+    update_changelog(newversion,"major")
     version_obj.update_version(newversion)
     replace_version(version_obj)
 
@@ -297,6 +328,7 @@ def bump_minor(version_obj, not_interactive):
     newversion = nums.group(1) + str(int(nums.group(2)) +1) + '.0-beta1'
     if (not not_interactive):
         confirm_replace(oldversion, newversion)
+    update_changelog(newversion,"minor")
     version_obj.update_version(newversion)
     replace_version(version_obj)
 
@@ -307,6 +339,7 @@ def bump_patch(version_obj, not_interactive):
     newversion = nums.group(1) + str(int(nums.group(2)) +1)
     if (not not_interactive):
         confirm_replace(oldversion, newversion)
+    update_changelog(newversion,"patch")
     version_obj.update_version(newversion)
     replace_version(version_obj)
 
@@ -319,6 +352,7 @@ def set_manual_version(version_obj, user_version, not_interactive):
     newversion = user_version
     if (not not_interactive):
         confirm_replace(oldversion, newversion)
+    update_changelog(newversion,"manual")
     version_obj.update_version(newversion)
     replace_version(version_obj)
 
@@ -328,6 +362,7 @@ def do_release(version_obj, not_interactive):
     newversion = re.sub(r'([\d.]+)-?.*', r'\1', oldversion)
     if (not not_interactive):
         confirm_replace(oldversion, newversion)
+    update_changelog(newversion,"release")
     version_obj.update_version(newversion)
     replace_version(version_obj)
 

contrib/Makefile.am

@@ -17,4 +17,4 @@
 
 SUBDIRS = TeXShop
 
-EXTRA_DIST = gprocess gabc.xml gabc.lang gabc.vim 900_gregorio.xml gregorio.png gabc-syntax.plist README.md system-setup.command system-setup.bat config-texworks.command checkSyllabation.py
+EXTRA_DIST = gprocess gabc.xml gabc.lang gabc.vim 900_gregorio.xml gregorio.png gabc-syntax.plist contrib_README.md system-setup.command system-setup.bat config-texworks.command checkSyllabation.py

contrib/README.md renamed to contrib/contrib_README.md

@@ -1,6 +1,6 @@
 # Third party scripts
 
-This repository contains various small scripts or modules for third-party softwares to use Gregorio.
+This folder contains various small scripts or modules for third-party softwares to use Gregorio.
 
 ## Scribus
 

debian/README.Debian

@@ -3,6 +3,6 @@ README file for Gregorio under DEBIAN GNU/Linux systems
 After the installation of gregorio, if you want to benefit from the macros
 compiling directly gabc fils in GregorioTeX (like \includescore), you
 have to add gregorio to the list of programs allowed to run from TeX
-by TeXLive. To do so, you have to modify /etc/texmf/texmf.cnf and add
+by TeX Live. To do so, you have to modify /etc/texmf/texmf.cnf and add
 gregorio to the list 'shell_escape_commands'.
 

debian/README.md renamed to debian/debian_README.md

@@ -68,4 +68,4 @@ maintainer-clean-local: clean-doc
 EXTRA_DIST = $(SRCFILES) $(NABCSRCFILES) \
 	     GregorioRef.pdf \
 	     GregorioNabcRef.pdf \
-	     README.md
+	     doc_README.md