fix #759 : added script to merge changelog files from all projects related to larray

Author: alixdamman

doc/source/changes/template.rst.inc

@@ -1,21 +1,22 @@
 .. py:currentmodule:: larray
 
+
 Syntax changes
---------------
+^^^^^^^^^^^^^^
 
 * renamed ``LArray.old_method_name()`` to :py:obj:`LArray.new_method_name()` (closes :issue:`1`).
 
 * renamed ``old_argument_name`` argument of :py:obj:`LArray.method_name()` to ``new_argument_name``.
 
 
 Backward incompatible changes
------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 * other backward incompatible changes
 
 
 New features
-------------
+^^^^^^^^^^^^
 
 * added a feature (see the :ref:`miscellaneous section <misc>` for details). It works on :ref:`api-axis` and
   :ref:`api-group` objects.
@@ -46,12 +47,12 @@ New features
 .. _misc:
 
 Miscellaneous improvements
---------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 * improved something.
 
 
 Fixes
------
+^^^^^
 
 * fixed something (closes :issue:`1`).

doc/source/changes/version_0_30.rst.inc

@@ -1,13 +1,14 @@
 .. py:currentmodule:: larray
 
+
 Syntax changes
---------------
+^^^^^^^^^^^^^^
 
 * new syntax
 
 
 Backward incompatible changes
------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 * :py:obj:`LArray.equals()` now returns True for arrays even when axes are in a different order or some axes are
   missing on either side (but the data is constant over that axis on the other side). To get back the old behavior, use
@@ -98,7 +99,7 @@ Backward incompatible changes
 
 
 New features
-------------
+^^^^^^^^^^^^
 
 * added :py:obj:`LArray.isin()` method to check whether each element of an array is contained in a list (or array) of
   values.
@@ -127,7 +128,7 @@ New features
 
 
 Miscellaneous improvements
---------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 * implemented a simpler pattern language in :py:obj:`Axis.matching()` and :py:obj:`Group.matching()`. In addition to
   regular expressions (which now require using the ``regexp`` argument), the two methods support the following simpler
@@ -277,7 +278,7 @@ Miscellaneous improvements
 
 
 Fixes
------
+^^^^^
 
 * fixed :py:obj:`LArray.divnot0()` being slow when the divisor has many axes and many zeros (closes :issue:`705`).
 

doc/source/merge_changelogs.py

@@ -0,0 +1,60 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+Append release notes from other projects of the larray-project constellation to the current changelog
+"""
+
+import os
+import requests
+
+from releaser import relname2fname
+
+
+# TODO: add Eurostat project
+LARRAY_GITHUB_REP = "https://github.com/larray-project/larray"
+EDITOR_GITHUB_REP = "https://github.com/larray-project/larray-editor"
+
+
+def include_changelogs(section_name, release_name, github_rep, rel_changes_dir='/doc/source/changes',
+                       branch='master', reset=False):
+    changelog_file = relname2fname(release_name)
+
+    # get changelog file content from github repository
+    url = github_rep.replace('github.com', 'raw.githubusercontent.com') \
+          + '/{}/{}/'.format(branch, rel_changes_dir) + changelog_file
+    req = requests.get(url)
+    if req.status_code != requests.codes.ok:
+        raise ValueError("Content at URL {} could not been found.".format(url))
+    github_changelog = req.text
+
+    # append to local changelog file
+    changelog_file = os.path.abspath(os.path.join('.', 'changes', changelog_file))
+    with open(changelog_file) as f:
+        content = f.read() if not reset else ''
+    with open(changelog_file, 'w', encoding="utf-8") as f:
+        new_section = """
+
+{section_name}
+{underline}
+
+""".format(section_name=section_name.upper(), underline='-' * len(section_name))
+        content += new_section
+        content += github_changelog
+        f.write(content)
+
+
+def merge_changelogs(release_name):
+    include_changelogs('CORE', release_name, LARRAY_GITHUB_REP, reset=True)
+    include_changelogs('EDITOR', release_name, EDITOR_GITHUB_REP)
+
+
+if __name__ == '__main__':
+    import sys
+
+    argv = sys.argv
+    if len(argv) < 2:
+        print("Usage: {} release_name".format(argv[0]))
+        sys.exit()
+
+    release_name = argv[1]
+    merge_changelogs(release_name)

make_release.py

@@ -8,13 +8,12 @@
 
 import sys
 from os.path import abspath, dirname, join
-
 from subprocess import check_call
-from releaser import make_release, update_feedstock, short, no, chdir, doechocall, set_config
+
+from releaser import make_release, update_feedstock, short, no, chdir, set_config, insert_step_func
 from releaser.make_release import steps_funcs as make_release_steps
 from releaser.update_feedstock import steps_funcs as update_feedstock_steps
 
-
 TMP_PATH = r"c:\tmp\larray_new_release"
 TMP_PATH_CONDA = r"c:\tmp\larray_conda_new_release"
 PACKAGE_NAME = "larray"
@@ -45,6 +44,19 @@ def fill(s):
                 'qtconsole', 'matplotlib', 'pyqt', 'qtpy', 'pytables', 'xlsxwriter', 'xlrd', 'openpyxl', 'xlwings'])
 
 
+def merge_changelogs(config):
+    if config['src_documentation'] is not None:
+        chdir(join(config['build_dir'], config['src_documentation']))
+
+        if not config['public_release']:
+            return
+
+        check_call(['python', 'merge_changelogs.py', config['release_name']])
+
+
+insert_step_func(merge_changelogs, msg='append changelogs from larray-editor project', before='update_changelog')
+
+
 # TODO : move to larrayenv project
 def announce_new_release(release_name):
     import win32com.client as win32
@@ -78,14 +90,14 @@ def announce_new_release(release_name):
         print("update conda-forge feedstock steps:", ', '.join(f.__name__ for f, _ in update_feedstock_steps))
         print("or")
         print("Usage: {} -a|--announce release_name".format(argv[0]))
-        print("Usage: {} -m release_name".format(argv[0]))
+        print("Usage: {} -m|--meta release_name".format(argv[0]))
         sys.exit()
 
     local_repository = abspath(dirname(__file__))
-    if argv[1] == '-m':
-        config = set_config(local_repository, PACKAGE_NAME, SRC_CODE, argv[2], branch='master',
-                            src_documentation=SRC_DOC, tmp_dir=TMP_PATH)
-        update_metapackage(config)
+    if argv[1] == '-m' or argv[1] == '--meta':
+        local_config = set_config(local_repository, PACKAGE_NAME, SRC_CODE, argv[2], branch='master',
+                                  src_documentation=SRC_DOC, tmp_dir=TMP_PATH)
+        update_metapackage(local_config)
     elif argv[1] == '-a' or argv[1] == '--announce':
         no("Is metapackage larrayenv updated?")
         announce_new_release(argv[2])