Skip to content
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.

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

Fix 1.3.1 release #113

Merged
merged 4 commits into from
Jan 20, 2025
Merged

Fix 1.3.1 release #113

merged 4 commits into from
Jan 20, 2025

Conversation

LucVV
Copy link
Contributor

@LucVV LucVV commented Jan 17, 2025

Proposed change

The release of version 1.3.1 failed to upload to PiPY. This seems to be due to two problems

  1. We did not update the version number in __init__.py
  2. Missing metadata in the PyPi upload resulting in an InvalidDistribution error in the GitHub action, likely due to an outdated version of pypa/gh-action-pypi-publish in python_publish.yaml

This PR adresses both:

  1. The version number in __init__.py is updated to '1.3.1'.
  2. The the version of pypa/gh-action-pypi-publish is updated to v1.12.3, in which the missing metadata should be fixed.

Type of change

  • Example (a notebook demonstrating how to use ZOSPy for a specific application)
  • Bugfix (non-breaking change which fixes an issue)
  • New analysis (a wrapper around an OpticStudio analysis)
  • New feature (other than an analysis)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests
  • Documentation (improvement of either the docstrings or the documentation website)

Additional information

  • Python version: 3.11
  • OpticStudio version: 20.3.2

Related issues

#112

Checklist

  • I have followed the contribution guidelines
  • The code has been linted, formatted and tested locally using tox.
  • Local tests pass. Please fix any problems before opening a PR. If this is not possible, specify what doesn't work and why you can't fix it.
  • I added new tests for any features contributed, or updated existing tests.
  • I updated CHANGELOG.md with my changes (except for refactorings and changes in the documentation).

If you contributed an analysis:

  • I did not use AttrDicts for the analysis result data (please use dataclasses instead).

If you contributed an example:

  • I contributed my example as a Jupyter notebook.

@LucVV LucVV added the skip changelog It is not necessary to update the changelog for this PR label Jan 17, 2025
@LucVV LucVV added this to the v1.3.1 milestone Jan 17, 2025
@LucVV LucVV requested a review from crnh January 17, 2025 14:07
Copy link
Collaborator

@crnh crnh left a comment

Choose a reason for hiding this comment

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

@LucVV did you run the test publish workflow to test if the problem has been solved?

Instead of exactly specifying v1.12.3, you should also be able to specify v1. This should always use the latest non-breaking version of the action.

@LucVV LucVV deployed to TestPyPI January 17, 2025 21:08 — with GitHub Actions Active
@LucVV
Copy link
Contributor Author

LucVV commented Jan 17, 2025

I changed from pypa/gh-action-pypi-publish@v1.12.3 to pypa/gh-action-pypi-publish@release/v1 , which should use the latest stagble release. The test publish workflow seems to work as intended with that.

@crnh crnh self-requested a review January 17, 2025 21:12
@crnh crnh merged commit 5d89950 into main Jan 20, 2025
22 checks passed
@crnh crnh deleted the fix_1.3.1_release branch January 20, 2025 07:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip changelog It is not necessary to update the changelog for this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants