Releases: sandialabs/staged-script
v2.0.5
v2.0.4
Chores
- chore: Update Ruff linters (
9bc25f7)
Code style
- style: Finish type-hinting (
ef76d16)
Patch
-
patch: Add SLSA provenance to release assets (
9050760)See https://slsa.dev/ for motivation.
Creating a patch release to ensure these additions to the automated
release process work.Note that the
releasejob has been subdivided, because the SLSA
provenance reusable workflow cannot be used as a step within a job, but
must be used as a job on its own.
Refactoring
-
refactor: Switch method to module function (
b7c26fc)I should have done this ages ago. Instead of
_validate_stage_name
being a static method in theStagedScriptclass, make it a function in
thestaged_scriptmodule. We then no longer need to ignore the MyPy
error about__class__being undefined, and Ruff's SLF linter won't
complain about private member access.
v2.0.3
v2.0.2
Chores
-
chore: Update security notice (
b101953)The Best Practices Badge App suggests we should document what users can
expect from our project in terms of security.
Code style
-
style: Sort imports (
3dd62ec)Discovered by ruff:
staged_script/__init__.py:21:11: RUF022 [*] `__all__` is not sorted | 19 | ) 20 | 21 | __all__ = [ | ___________^ 22 | | "StagedScript", 23 | | "HelpFormatter", 24 | | "RetryStage", 25 | | "StageDuration", 26 | | ] | |_^ RUF022 27 | __version__ = "2.0.0" | = help: Apply an isort-style sorting to `__all__`
Continuous integration
- ci: Replace deprecated GitHub Action (
a300200)
Documentation
-
docs: Switch to
project_copyright(43f1d31)Using this alias means we're no longer overshadowing the
copyright
built-in, so we can remove the comment to ignore that Ruff linting rule.
Patch
- patch: Omit auto-updates from CHANGELOG (
a61c6ea)
Refactoring
- refactor: Fix issues from ruff-pre-commit update (
ecce915)
v2.0.1
v2.0.0
Chores
-
chore!: Drop support for Python 3.8 (
a9c8005)- Use type-hinting provided out of the box in 3.9.
- Use new dictionary update syntax.
- Update the docs and CI accordingly.
-
chore: Group dependabot updates (
aef5ea5)Run dependabot updates weekly instead of daily, and group them together
for the different providers (GitHub Actions and pip), to reduce the
amount of noise in the repository history. -
chore(deps): No longer pin Sphinx version (
21d0cc4)sphinx-rtd-theme has been updated to work with the latest Sphinx
version. -
chore(deps): Update sphinx requirement from <8.0.0 to <9.0.0 (
b554db0)Updates the requirements on sphinx to permit the latest version.
updated-dependencies:
- dependency-name: sphinx
dependency-type: direct:production
...
Signed-off-by: dependabot[bot] support@github.com
- dependency-name: sphinx
-
chore: Update LICENSE/COPYRIGHT files (
bcf3433) -
chore: Change license title (
6d30b36)Try updating the title of the LICENSE.md file to see if that fixes
https://github.com/sandialabs/staged-script/security/code-scanning/33.
Continuous integration
-
ci: Fix typo (
bd4d832)Should have been included in 627a50f.
-
ci: Restrict CI permissions to read (
627a50f)https://github.com/sandialabs/staged-script/security/code-scanning/20
-
ci: Change documentation coverage file name (
35c39d8) -
ci: Tweak automated suggestions (
0f0b3d3) -
ci: Apply security best practices (
5a2ca31)Signed-off-by: StepSecurity Bot bot@stepsecurity.io
Documentation
-
docs: Add real-world example (
30bd774)Include the GMS system-level testing class hierarchy as an example of
the significant flexibility afforded by thestaged-scriptframework. -
docs: Pin Sphinx version (
3a1c80d)The Sphinx 8.0.0 release causes problems with sphinx-rtd-theme, so I'm
pinning Sphinx below 8.0 to get things back up and running again. -
docs: Fix lines included from examples (
8dd8fb4)Should have been included in ccfa0d9.
Testing
-
test: Remove unnecessary parentheses (
b190ac6)To align with updated ruff rules.
v1.0.2
v1.0.1
Chore
-
chore: Add CHANGELOG (
c5ce0f4)Add a dummy CHANGELOG.md to be overwritten by Semantic Release.
-
chore: Add example requirements (
343b8e7)Add a blank requirements file for the examples to facilitate adding
requirements in the future.
Continuous Integration
-
ci: Omit
--fixarg (2207516)When running
ruffvia pre-commit, don't automatically fix the
problems; instead tell the user what's wrong to train them into not
making the problems in the first place. -
ci: Add semantic release templates (
0cb13c1)Add templates for the release notes and
CHANGELOGso
python-semantic-releasecan generate these files correctly in CI. -
ci: Check documentation spelling and coverage (
e5b3719) -
ci: Add semantic release workflow (
7725e5e)
Documentation
- docs: Slight tweaks to contributing guidelines (
59325de)
Patch
-
patch: Indicate that the package is typed (
55a20c9)According to PEP 561, we need to add this file to static type checkers
can infer the types from the package.
Test
- test: Run the examples and check their output (
ccfa0d9)
Initial Release
Merge pull request #25 from sandialabs/prepare-for-initial-release docs: Remove WIP banner