-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
165 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| #!/usr/bin/env python3 | ||
| import argparse | ||
| import re | ||
| import subprocess | ||
|
|
||
|
|
||
| def run_towncrier(tag): | ||
| cmd = ("towncrier", "build", "--version", tag.strip("v")) | ||
|
|
||
| return subprocess.call(cmd) | ||
|
|
||
|
|
||
| def update_fallback_version_in_pyproject(tag, fname="pyproject.toml"): | ||
| version = tag.strip("v").split(".") | ||
| # Default to +1 on minor version | ||
| major, minor = version[0], int(version[1]) + 1 | ||
|
|
||
| with open(fname, "r") as file: | ||
| lines = file.readlines() | ||
|
|
||
| pattern = "fallback_version" | ||
| new_version = f"{major}.{minor}.dev0" | ||
| # Iterate through the lines and find the pattern | ||
| for i, line in enumerate(lines): | ||
| if re.search(pattern, line): | ||
| lines[i] = f'{pattern} = "{new_version}"\n' | ||
| break | ||
|
|
||
| # Write the updated content back to the file | ||
| with open(fname, "w") as file: | ||
| file.writelines(lines) | ||
|
|
||
| print( | ||
| f"\nNew (fallback) dev version ({new_version}) written to `pyproject.toml`.\n" | ||
| ) | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| # Get tag argument | ||
| parser = argparse.ArgumentParser() | ||
| parser.add_argument("tag") | ||
| args = parser.parse_args() | ||
| tag = args.tag | ||
|
|
||
| # Update release notes | ||
| run_towncrier(tag) | ||
|
|
||
| # Update fallback version for setuptools_scm | ||
| update_fallback_version_in_pyproject(tag) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Migrate to HyperSpy 2.0, drop python 2.7 and add python 3.12 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Consolidate packaging in ``pyproject.toml`` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| This directory contains "news fragments" which are short files that contain a small **ReST**-formatted | ||
| text that will be added to the next ``CHANGELOG``. | ||
|
|
||
| The ``CHANGELOG`` will be read by **users**, so this description should be aimed to hyperspy users | ||
| instead of describing internal changes which are only relevant to the developers. | ||
|
|
||
| Each file should be named like ``<ISSUE>.<TYPE>.rst``, where | ||
| ``<ISSUE>`` is an issue number, and ``<TYPE>`` is one of: | ||
|
|
||
| * ``new``: new user facing features, like new command-line options and new behavior. | ||
| * ``bugfix``: fixes a bug. | ||
| * ``doc``: documentation improvement, like rewording an entire session or adding missing docs. | ||
| * ``deprecation``: feature deprecation. | ||
| * ``enhancements``: improvement of existing functionality, usually without requiring user intervention. | ||
| * ``api``: a change which may break an existing script, such as feature removal or behavior change. | ||
| * ``maintenance``: a change related to the test suite, packaging, etc. | ||
|
|
||
| So for example ``1412.new.rst`` or ``2773.bugfix.rst``. | ||
|
|
||
| If your PR fixes an issue, use the number of the issue here. If there is no issue, | ||
| then after you submit the PR and get the PR number you can add a | ||
| changelog using that instead. | ||
|
|
||
| If you are not sure what issue type to use, don't hesitate to ask in your PR. | ||
|
|
||
| ``towncrier`` preserves multiple paragraphs and formatting (code blocks, lists, and so on), but for entries | ||
| other than ``new`` it is usually better to stick to a single paragraph to keep it concise. For ``new``, | ||
| it is recommended to add a hyperlink to the user guide. | ||
|
|
||
| To make a draft of the changelog, run from the command line: | ||
|
|
||
| .. code-block:: bash | ||
| $ towncrier build --draft | ||
| See https://github.com/twisted/towncrier for more details. |