Skip to content

Commit

Permalink
Merge pull request #135 from mrakitin/doc-rel-notes-v0.7.0
Browse files Browse the repository at this point in the history
DOC: release notes for v0.7.0
  • Loading branch information
thomaswmorris authored Aug 4, 2023
2 parents f819e1b + 7790567 commit 92d2f2c
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 1 deletion.
5 changes: 4 additions & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ on:
push:
pull_request:
workflow_dispatch:
release:
types: [created]

jobs:
build_docs:
Expand Down Expand Up @@ -86,7 +88,8 @@ jobs:
path: docs/build/html/

- name: Deploy documentation to nsls-ii.github.io
if: github.repository_owner == 'NSLS-II' && github.ref_name == 'main'
# if: github.repository_owner == 'NSLS-II' && github.ref_name == 'main'
if: github.event_name == 'release'
# We pin to the SHA, not the tag, for security reasons.
# https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
uses: peaceiris/actions-gh-pages@bbdfb200618d235585ad98e965f4aafc39b4c501 # v3.7.3
Expand Down
36 changes: 36 additions & 0 deletions docs/source/release-history.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,42 @@
Release History
===============

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

New features
............
- Created ``.json`` and ``.yaml`` CLI exporters and added relevant tests.

API
...
- Added ``stateless-compute`` support for CRL, Crystal, and Undulator objects in
the Sirepo/SRW app.
- Implemented Ophyd support for Propagation parameters in the Sirepo/SRW app.
- Converted integer Sirepo parameters to floats to fix the ``failed to format
row`` error in Bluesky's ``LiveTable``.
- Added a lightweight method that computes the beam position and FWHM before it
is turned into a document for SRW and Shadow apps. The beam stats show up in
Bluesky's ``BestEffortCallback``.
- Removed old API support and relevant tests.

Documentation
.............
- Suppress Shadow3 code's stdout in notebooks/code.
- Converted project's `README.rst` to `README.md` for better rendering on PyPI.

Examples
........
- Added an empty beamline simulation (``sim_id="emptysim"``) to the list of
predefined examples.
- Fixed MAD-X app's configuration to correctly display the UI components
(disabled React frontend).

Linting/styling
................
- Added ``black`` formatter for Jupyter notebooks.


v0.6.2 (2023-06-09)
-------------------
This is a maintenance release with small API, tests, packaging, and documentation updates.
Expand Down

0 comments on commit 92d2f2c

Please sign in to comment.