From c8adbaeb7af25591d55edaa4cceb2cd1acc6f4cf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A5kon=20Wiik=20=C3=85nes?= Date: Fri, 22 Jan 2021 10:31:17 +0100 Subject: [PATCH 1/3] Fix release version links used by Binder and nbsphinx MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Håkon Wiik Ånes --- doc/changelog.rst | 12 ++++++++++++ doc/conf.py | 2 +- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/doc/changelog.rst b/doc/changelog.rst index 6a048068..110d0a1f 100644 --- a/doc/changelog.rst +++ b/doc/changelog.rst @@ -12,6 +12,18 @@ project adheres to `Semantic Versioning `_. Contributors to each release are listed in alphabetical order by first name. List entries are sorted in descending chronological order. +Unreleased +========== + +Contributors +------------ +- Håkon Wiik Ånes + +Fixed +----- +- Version link Binder uses to make the Jupyter Notebooks run in the browser. + (`#301 `_) + 0.3.0 (2021-01-22) ================== diff --git a/doc/conf.py b/doc/conf.py index 579e3fb0..079b8c34 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -113,7 +113,7 @@ if "dev" in version: release_version = "master" else: - release_version = version + release_version = "v" + version # This is processed by Jinja2 and inserted before each notebook nbsphinx_prolog = ( r""" From 3a9867b156b51d4accf5bc78d20defdd4315f8bd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A5kon=20Wiik=20=C3=85nes?= Date: Fri, 22 Jan 2021 11:10:55 +0100 Subject: [PATCH 2/3] Update release version, notebook argument MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Håkon Wiik Ånes --- RELEASE.rst | 10 ++++++++-- doc/changelog.rst | 4 ++-- doc/pattern_matching.ipynb | 3 ++- kikuchipy/release.py | 2 +- 4 files changed, 13 insertions(+), 6 deletions(-) diff --git a/RELEASE.rst b/RELEASE.rst index f8a66319..2468aa27 100644 --- a/RELEASE.rst +++ b/RELEASE.rst @@ -22,8 +22,14 @@ This guide should be updated after every new release! release branch: https://readthedocs.org/projects/kikuchipy/. - On the master branch, increment the version number in `release.py` to the next - ``.dev0``. - + `.dev0`. +- If a release candidate (RC) is to be made, make a PR to the release branch + with `-rc.1` added to the version name, like v0.42.0-rc.1, merge the PR after + all checks pass, and publish an RC release off of the release branch. See that + it is made available via PyPI, download it with the `dev` dependencies, and + run the tests to make sure everything is as it should be. Also check that + Binder can build the repository successfully by going to the Read the Docs PR + check in the RC PR above after the RC release. - Create a release draft (tag) via the GitHub repo from the release branch with the correct tag version name, e.g. v0.42.x and release title (see previous releases). Add the new release notes from the changelog. Publish the release. diff --git a/doc/changelog.rst b/doc/changelog.rst index 110d0a1f..3278dc62 100644 --- a/doc/changelog.rst +++ b/doc/changelog.rst @@ -12,8 +12,8 @@ project adheres to `Semantic Versioning `_. Contributors to each release are listed in alphabetical order by first name. List entries are sorted in descending chronological order. -Unreleased -========== +0.3.1 (2021-01-22) +================== Contributors ------------ diff --git a/doc/pattern_matching.ipynb b/doc/pattern_matching.ipynb index 5a19a53c..c236f7c4 100644 --- a/doc/pattern_matching.ipynb +++ b/doc/pattern_matching.ipynb @@ -69,7 +69,8 @@ "import kikuchipy as kp\n", "\n", "\n", - "s = kp.data.nickel_ebsd_large() # Use kp.load(\"data.h5\") to load your own data\n", + "# Use kp.load(\"data.h5\") to load your own data\n", + "s = kp.data.nickel_ebsd_large(allow_download=True) # External download\n", "s" ] }, diff --git a/kikuchipy/release.py b/kikuchipy/release.py index 198bc5e7..2c9ea81c 100644 --- a/kikuchipy/release.py +++ b/kikuchipy/release.py @@ -34,4 +34,4 @@ name = "kikuchipy" platforms = ["Linux", "MacOS X", "Windows"] status = "Development" -version = "0.3.0" +version = "0.3.1" From b255616cb4b6411259fb11c4ceb86cc338a09d0d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A5kon=20Wiik=20=C3=85nes?= Date: Fri, 22 Jan 2021 11:42:56 +0100 Subject: [PATCH 3/3] Fix changelog link MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Håkon Wiik Ånes --- doc/changelog.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/changelog.rst b/doc/changelog.rst index 3278dc62..2b2ab4ce 100644 --- a/doc/changelog.rst +++ b/doc/changelog.rst @@ -22,7 +22,7 @@ Contributors Fixed ----- - Version link Binder uses to make the Jupyter Notebooks run in the browser. - (`#301 `_) + (`#301 `_) 0.3.0 (2021-01-22) ==================