Skip to content

Release 22.11.15

Latest
Compare
Choose a tag to compare
@drasmuss drasmuss released this 15 Nov 15:56
· 46 commits to main since this release

Added

  • Added support for new one_page option in nengo-sphinx-theme. (#101)
  • Added the bones-format-notebook script to apply automated formatting, cleanup, and static checking to Jupyter notebooks. (#32)
  • Static script will now check that bones-format-notebook has been applied to all notebooks in the docs directory. (#32)
  • Added remote-script.sh CI script for running other CI scripts on a remote device. (#124)
  • Added isort configuration to pyproject.toml and check import order during static checks. (#121)
  • Officially support and test against Python 3.9. (#136)
  • Added skip option to codespell config, which can be used to specify files that should be ignored. (#138)
  • Added support for projects with type hints through the py_typed section. (#140)
  • Added min_python option to the main section. The default python_requires in setup.py is now based on this, if not overridden. (#140)
  • Added support for changing the main branch name with the main_branch config option. (#145)
  • Added template for version.py. (#151)
  • Added apache license type. (#160)
  • Added proprietary license type. (#162)
  • Added several actions for use with Github Actions: setup initializes a python environment, generate-and-check runs bones-generate and bones-check, run-script runs a CI script such as static.sh, and coverage-report generates combined coverage reports. (#166)
  • Added support for docformatter (and static checks will now enforce that docformatter has been applied). (#168)
  • Added support for building and releasing Python projects through the deploy CI script. (#172)
  • Added a bones check-deploy script that checks several items that we depend on for releases. (#172)

Changed

  • Restrict pylint version to <2.5 due to issue when the package being checked is not installed in the current environment. (#103)
  • Increased minimum pylint version to 2.5.1 (#32)
  • Documentation [source] links now point to GitHub. (#117)
  • Separate tokens, PYPI_TOKEN and PYPI_TEST_TOKEN, must now be specified for deploying to PyPI and TestPyPI, respectively. (#127)
  • Builds for this repository now run on TravisCI.com instead of TravisCI.org. (#130)
  • Drop support for Python 3.5. (#123)
  • Doc script will now install Sphinx>=3.1.2. (#137)
  • Codespell ignore words is now specified via the codespell.ignore_words section of setup_cfg (instead of in the static CI script config). As a result, it will now apply to all invocations of codespell (not just from the static script). (#138)
  • bones-format-notebook --check will now require that all codespell checks pass. (#138)
  • Switched to new version of Codecov uploader and added checksum verification. (#150)
  • Increased minimum black version to 21.12b0. (#104, #159)
  • License fields in setup.py are now set using license_rst.type. (#161)
  • Trove classifiers in setup.py are now sorted alphabetically. (#161)
  • Updated Nengo license and renamed to ABR license. (#157)
  • The license type is now specified through a license key at the top level. If not specified, it defaults to proprietary. (#157)
  • All CI scripts now support running either through Github Actions or TravisCI. (#166)
  • Added additional config options to mypy setup.cfg template. (#170)
  • Restrict setuptools version to <64 (fixes issues with various code inspection tools like mypy, pylint, IDE integrations). (#173)
  • Removed the deploy_dists configuration option for the deploy script, and replaced it with a boolean wheel option. (#172)
  • Consolidated all scripts under a single bones command. Subcommands have the same names as before, without the bones- prefix (e.g., bones-generate is now bones generate). (#172)

Removed

  • Removed before_script, before_cache, before_deploy, and after_deploy steps from CI scripts (they weren't actually used anywhere). (#166)
  • Removed analytics_id option for docs/conf.py. Create a custom docs/conf.py template and override the analytics block if you need to customize analytics tracking. (#169)
  • Removed support for TravisCI in CI scripts. All downstream repositories should switch to use Github Actions. (#172)

Fixed

  • Intermittent failures installing miniconda in the remote script have been fixed by retrying the miniconda install if it fails. (#130)
  • Fixed an issue in which Codecov would not report on files where a file in a deeper folder shares the same name. (#132)
  • Fixed an issue in which CI scripts did not have access to the same configuration options as other templates. (#144)
  • Removed pylint disable for bad-continuation as it no longer exists. (#163)
  • Removed pylint disable for no-self-use as it is now optional. (#163)
  • Static checks will not try to check docs directory if it doesn't exist. (#165)
  • Static checks will no longer assume that CI scripts are in a folder named .ci (it will look for any scripts in the same folder as the static script). (#166)
  • Black will now ignore excluded files even if that filename is passed directly to black (e.g. when running through a precommit hook or IDE plugin). (#161)
  • Only delete remote build directories more than a day old. (#172)