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

tidy scripts #69

Merged
merged 3 commits into from
Jul 24, 2024
Merged

tidy scripts #69

merged 3 commits into from
Jul 24, 2024

Conversation

mnbf9rca
Copy link
Owner

@mnbf9rca mnbf9rca commented Jul 23, 2024

Summary by Sourcery

This pull request updates the CI workflows by renaming them for better clarity and making the target environment for publishing package distributions dynamic.

  • CI:
    • Updated workflow names for clarity in deploy_to_pypi.yml and deploy_workflow_wrapper.yml.
    • Modified deploy_to_pypi.yml to dynamically use the target environment for publishing package distributions.

Copy link

sourcery-ai bot commented Jul 23, 2024

Reviewer's Guide by Sourcery

This pull request focuses on tidying up the GitHub Actions workflows by standardizing naming conventions and improving clarity. The changes include correcting the capitalization of 'PyPi' to 'PyPI' and updating job names to be more descriptive and flexible.

File-Level Changes

Files Changes
.github/workflows/deploy_to_pypi.yml
.github/workflows/deploy_workflow_wrapper.yml
Standardized naming conventions and improved clarity in workflow names and job descriptions.

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • 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

@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 @mnbf9rca - I've reviewed your changes and they look great!

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

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.

@@ -1,4 +1,4 @@
name: Publish the completed package to Pypi
name: Publish the completed package to PyPi
Copy link

Choose a reason for hiding this comment

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

issue (typo): Inconsistent capitalization of 'PyPi'

The correct capitalization is 'PyPI'. This should be corrected to maintain consistency and accuracy.

@@ -45,7 +45,7 @@ jobs:
# version=$(grep 'version =' pyproject.toml | awk '{print $3}' | sed 's/"//g')
# echo "VERSION=$version" >> $GITHUB_ENV
# echo "extracted version '{{ $env.VERSION }}' from pyproject.toml"
- name: Publish package distributions to TestPyPI
- name: Publish package distributions to ${{ inputs.target-environment }}
Copy link

Choose a reason for hiding this comment

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

issue (bug_risk): Potential issue with input variable naming

The input variable 'target-environment' should be checked to ensure it is correctly defined and passed. If it is not defined, this could lead to runtime errors.

@@ -1,4 +1,4 @@
name: build artifact and publish to pypi test
name: build artifact and publish to pypi
Copy link

Choose a reason for hiding this comment

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

issue (typo): Inconsistent capitalization of 'pypi'

The correct capitalization is 'PyPI'. This should be corrected to maintain consistency and accuracy.

@mnbf9rca mnbf9rca merged commit 3366d4f into main Jul 24, 2024
6 checks passed
@mnbf9rca mnbf9rca deleted the chore/tidy-up-deployment-scripts branch July 24, 2024 02:39
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