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

Packaging and initial readme #12

Merged
merged 5 commits into from
Apr 25, 2024

Conversation

turetske
Copy link
Collaborator

A slightly better readme documentation.

Adds workflows for the both the pypi and test-pypi packaging. The logic being that eventually, on "release" we'll want to publish the package to pypi.org but on a "pre-release" we want to publish to test-pypi.

Owners and maintainers in for the pelicanfs can also still publish distributions from outside of github if needed. There is currently a pelicanfs package on pypi with this version of the source code now, but the workflows are preparing for the future.

@turetske turetske requested a review from bbockelm April 16, 2024 21:30
This was linked to issues Apr 16, 2024
- Added an always-run job so that the job doesn't exit with a failure when a condition is skipped
- Fixed yaml syntax errors
Copy link
Member

@jhiemstrawisc jhiemstrawisc left a comment

Choose a reason for hiding this comment

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

A few comments that you're welcome to ignore since this is all pre-alpha, and one actual change request, which is to add the missing newline to the end of these files.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
.github/workflows/pypi-publish.yml Show resolved Hide resolved
Copy link
Member

@jhiemstrawisc jhiemstrawisc left a comment

Choose a reason for hiding this comment

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

LGTM

@turetske turetske merged commit 9ba2efc into PelicanPlatform:main Apr 25, 2024
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.

Add better README/Documentation Package the code
2 participants