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

chore: refine PyPI deployment workflow and update contributing guidelines #19

Merged
merged 9 commits into from
Jun 16, 2024

Conversation

yazdipour
Copy link
Owner

@yazdipour yazdipour commented Jun 16, 2024

Closes #IssueNr

📑 Description

✅ Checks

  • My pull request adheres to the code style of this project
  • My code requires changes to the documentation
  • I have updated the documentation as required
  • All the tests have passed

ℹ Additional Information

Summary by Sourcery

This pull request refines the PyPI deployment workflow by updating the tag pattern for releases and enhances the contributing guidelines with a new section on the release process.

  • CI:
    • Refined the PyPI deployment workflow by updating the trigger for releases to match any tag pattern.
  • Documentation:
    • Updated contributing guidelines to include a new section on the release process, detailing steps for tagging and pushing to GitHub for automatic PyPI publishing.

Copy link
Contributor

sourcery-ai bot commented Jun 16, 2024

Reviewer's Guide by Sourcery

This pull request refines the PyPI deployment workflow and updates the contributing guidelines. The 'CONTRIBUTING.md' file now includes a 'Release process' section detailing the steps to create and push a new tag for automatic PyPI release. The '.github/workflows/publish.yml' file has been updated to rename the workflow and modify the tag pattern to trigger the workflow on any tag push.

File-Level Changes

Files Changes
CONTRIBUTING.md
.github/workflows/publish.yml
Refined the PyPI deployment workflow and updated the contributing guidelines to include the release process.

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @yazdipour - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 2 issues found

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

.github/workflows/publish.yml Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@yazdipour yazdipour merged commit bbeb940 into main Jun 16, 2024
4 checks passed
@yazdipour yazdipour deleted the bugfix/redef-release-process branch June 16, 2024 16:30
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.

1 participant