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

Automatic version update #126

Merged
merged 7 commits into from
Dec 12, 2023
Merged

Automatic version update #126

merged 7 commits into from
Dec 12, 2023

Conversation

MilesF25
Copy link
Collaborator

When creating a pull request to add a new feature or alter an existing one,
there are some important elements to include to help our team review and process it more efficiently.

  1. Make sure the title is descriptive of what the PR includes. Don't mention issue names/numbers; save that for the description.
    Automating push to PyPi.

  2. List the names of those who contributed to the project.
    @VitalJoseph , @KellerLiptrap , @MilesF25 , @Poiuy7312, @boulais01

  3. Link the issue the pull request is meant to fix/resolve.
    Automate Version Updates For PyPi #80

  4. Describe the contents and goal of the pull request.

The goal is to be able to automate pushing to PyPi

  1. Will coverage be maintained/increased?
    Maintained
  2. What operating systems has this been tested on? How were these tests conducted?
    None
  3. Include a code block and/or screenshots displaying the functionality of your feature, if applicable/possible.

Mark as a draft until it is ready to begin the reviewing process, then tag our Lead Software Architect, Lauren Nevill,
our Principal Software Engineer, Bergas Batara, and our Founding Engineer, Gregory Kapfhammer
when you mark it as ready for review.

@MilesF25 MilesF25 linked an issue Dec 12, 2023 that may be closed by this pull request
Copy link
Collaborator

@AidanNeeson AidanNeeson left a comment

Choose a reason for hiding this comment

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

I'm not entirely sure how twine works when it comes to building a package, I cannot seem to locate where it is capturing all of the projects dependencies. I would much rather an approach that uses poetry the tool we are already using. There are commands that are a part of poetry that can assist with this issue, I would recommend looking there. For example, the command poetry version will bump the version number in the toml to a specified number.

update_version.py Outdated Show resolved Hide resolved
.github/workflows/release_to_pypi.yml Outdated Show resolved Hide resolved
Copy link
Collaborator

@AidanNeeson AidanNeeson left a comment

Choose a reason for hiding this comment

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

This makes the workflow a lot simpler. Extra steps could be taken to see consistency with the version number listed in the toml and what is on PyPI, but I think this is a good first step at making sure releases can be done consistently.

@Poiuy7312 Poiuy7312 self-requested a review December 12, 2023 21:10
Copy link
Collaborator

@Poiuy7312 Poiuy7312 left a comment

Choose a reason for hiding this comment

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

Think this looks good

@MilesF25 MilesF25 merged commit 61059c9 into master Dec 12, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Automate Version Updates For PyPi
6 participants