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.

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

Jump to bottom

Setup automated publishing for pypi #16

Closed
devraj opened this issue Nov 26, 2023 · 1 comment
Closed

Setup automated publishing for pypi #16

devraj opened this issue Nov 26, 2023 · 1 comment
Assignees
@devraj
Labels
admin Administrative tasks such as infrastructure related
Milestone
alpha-finalisation

Comments

@devraj
Copy link
Member

devraj commented Nov 26, 2023

pypi has a Github action to publish software releases on pypi. At the moment we are already running tests using Github actions which runs the tests against a Cloud hosted Command Centre (running in AWS).

The suggested release lifecycle should be

  • A developer has a pull request for the next set of feature changes
  • All tests run and pass
  • Documentation is compiled and published using the Github action
  • A version is tagged using semver conventions
  • Release notes are published as a Github release
  • Upon the release going out a job is triggered to publish the package onto pypi
  • Update local tags and documentation with the links (if applicable)
@devraj devraj self-assigned this Nov 26, 2023
devraj added a commit that referenced this issue Nov 29, 2023
@devraj
chore: update meta data in preperation for pypi
44aa5d9 
the project is now registered on pypi, initially published through
my personal development computer, we want to eventually move this to
be part of our ci/cd pipeline and publish the package through a github
action REFS #16
@devraj devraj added the admin Administrative tasks such as infrastructure related label Dec 3, 2023
@devraj
Copy link
Member Author

devraj commented Feb 5, 2024

Note that this may be effected by our move to hatch

@devraj devraj mentioned this issue Mar 27, 2024
Merged
@devraj devraj added this to the rc-1 milestone Apr 14, 2024
@devraj devraj modified the milestones: rc-1, alpha-3 Jun 29, 2024
devraj added a commit that referenced this issue Jun 29, 2024
@devraj
fix: pypi classifiers
534e233 
had incorrect framework classifiers that prevented publishing
refs #16
devraj added a commit that referenced this issue Jun 29, 2024
@devraj
fix: build and publish task
c9705af 
refs #16
devraj added a commit that referenced this issue Jun 29, 2024
@devraj
fix: removes diabled test suite
04fc428 
finalising the package publishing post test suite success
refs #16
devraj added a commit that referenced this issue Jun 29, 2024
@devraj
fix: removes ci run on push to master
2c676fe 
this moves the ci run when there is a pull request on
the master branch, if this succeeds then it should be good
to merge changes into master

the publish action runs test before we push to pypi

note that pypi has a restriction where a filename cannot be used
https://pypi.org/help/#file-name-reuse
once it has been published, this means we will have a few rouge
alpha file releases to test the auto publish

for most use cases we should ignore the alpha releases as they
will be massive on the bleeding edge

refs #16
@devraj devraj closed this as completed Jun 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@devraj devraj

Labels
admin Administrative tasks such as infrastructure related
Projects
None yet
Milestone
alpha-finalisation
Development

No branches or pull requests
1 participant
@devraj