Skip to content

Commit

Permalink
Merge pull request #142 from mrakitin/doc-release-notes-v0.7.1
Browse files Browse the repository at this point in the history
DOC: release notes for v0.7.1
  • Loading branch information
mrakitin authored Aug 18, 2023
2 parents 177f5e2 + fa4f628 commit 4244521
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.9"]
python-version: ["3.10"]
fail-fast: false

defaults:
Expand Down
4 changes: 2 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ repos:
- id: end-of-file-fixer
- id: trailing-whitespace
- repo: https://github.com/ambv/black
rev: 23.3.0
rev: 23.7.0
hooks:
- id: black
language_version: python3.10
Expand All @@ -17,7 +17,7 @@ repos:
exclude: ^(.*\.py)
args: [--line-length=88]
- repo: https://github.com/pycqa/flake8
rev: 6.0.0
rev: 6.1.0
hooks:
- id: flake8
- repo: https://github.com/pycqa/isort
Expand Down
42 changes: 42 additions & 0 deletions docs/source/release-history.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,51 @@
Release History
===============

v0.7.1 (2023-08-18)
-------------------

This is a maintenance release with small API, tests, CI, and documentation updates.

API
...

- Enabled generation of beamline elements from existing simulations.
- Moved and updated the ``prepare_*_env.py`` code from the ``examples/``
directory of the repository to the library code, so that the new module can be
imported in IPython and Jupyter notebooks (both interactively and in the docs).
The ``argparser`` CLI argument parser was added to the module so that users can
specify the databroker config name and root path for the data files.

Documentation
.............

- Pinned ``furo`` minimum version to 2023.8.17 for compatiblity with Sphinx 7.2.0
and 7.2.1.

Tests
.....

- Sorted out test failures happening due to a small numerical difference of the
results from the PyPI-installed ``srwpy`` in the Sirepo Docker image.
- Removed an old/irrelevant test.

CI improvements
...............

- Switched from the conda action to built-in Python for CI (saves >2 minutes per
run).


v0.7.0 (2023-08-04)
-------------------

This is a major release with new features to support the ``stateless-compute``
API and propagation parameters in Sirepo/SRW and the old API used prior to
v0.4.0 removed.

This release includes many useful contributions from the SULI 2023 summer intern
Riley Bode. Thank you!

New features
............
- Created ``.json`` and ``.yaml`` CLI exporters and added relevant tests.
Expand Down
4 changes: 2 additions & 2 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ pytest
vcrpy>=4.3.1
# These are dependencies of various sphinx extensions for documentation.
# cloud-sptheme
furo
furo>=2023.8.17
ipython
jupyter
matplotlib
nbsphinx
numpydoc
pandoc
sphinx==7.1.2
sphinx
sphinx-copybutton
tabulate>=0.9.0

0 comments on commit 4244521

Please sign in to comment.