Skip to content

fix: resolve LICENSE conflict, upgrade to PyPI Trusted Publishing, add CHANGELOG #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
samdporter merged 2 commits into from
Apr 15, 2026
Merged

fix: resolve LICENSE conflict, upgrade to PyPI Trusted Publishing, add CHANGELOG #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b616a78
Initial plan
Copilot Apr 15, 2026
272df0b
fix: resolve LICENSE conflict, add Trusted Publishing, add CHANGELOG
Copilot Apr 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ on:
jobs:
publish:
runs-on: ubuntu-latest
permissions:
id-token: write
Comment on lines +10 to +11
Copy link
Copy Markdown

@sourcery-ai sourcery-ai bot Apr 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (bug_risk): Setting only id-token: write will revoke other default permissions and likely break actions/checkout.

Defining permissions overrides all defaults, so anything not listed is set to none (including contents: read), which actions/checkout@v4 needs.

To keep checkout working while enabling OIDC for PyPI, you can set:

jobs:
  publish:
    permissions:
      contents: read
      id-token: write

so the workflow still has read access to the repo while granting the required ID token permission.

steps:
- uses: actions/checkout@v4
- name: Set up Python
Expand All @@ -22,6 +24,4 @@ jobs:
- name: Check package
run: twine check dist/*
- name: Publish to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
with:
password: ${{ secrets.PYPI_API_TOKEN }}
uses: pypa/gh-action-pypi-publish@release/v1
18 changes: 18 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.5.0] - 2024-01-01

### Added
- Python SIMIND Monte Carlo connector for SPECT imaging simulations.
- STIR/SIRF adaptor for reading and writing SIMIND output data compatible with the STIR/SIRF reconstruction framework.
- PyTomography adaptor for integration with the PyTomography reconstruction library.
- Support for SIMIND `.atn` attenuation map data files.
- Helper utilities for configuring and running SIMIND Monte Carlo simulations from Python.
- Comprehensive test suite using `pytest`.
- Documentation hosted on ReadTheDocs.
Copy link
Copy Markdown

@sourcery-ai sourcery-ai bot Apr 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick (typo): Consider using the official service name "Read the Docs" instead of "ReadTheDocs".

The service’s official branding uses spaces: “Read the Docs.” Please update this bullet accordingly, e.g. “Documentation hosted on Read the Docs.”

Suggested change
- Documentation hosted on ReadTheDocs.
- Documentation hosted on Read the Docs.

- PyPI packaging (`py-smc`) with optional `dev` and `examples` dependency groups.
Loading
Loading