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

release: v1.2.0 #16

Merged
merged 1 commit into from
Dec 1, 2024
Merged

release: v1.2.0 #16

merged 1 commit into from
Dec 1, 2024

Conversation

Tohrusky
Copy link
Member

@Tohrusky Tohrusky commented Dec 1, 2024

Summary by Sourcery

Update the release workflow to trigger on tag pushes and add a GitHub release job. Bump the project version to v1.2.0 and introduce a new test for SubtitleTranslator initialization.

CI:

  • Update CI workflow to trigger on tag pushes with pattern 'v*'.

Tests:

  • Add a new test for SubtitleTranslator initialization to verify model and API configurations.

Copy link

sourcery-ai bot commented Dec 1, 2024

Reviewer's Guide by Sourcery

This release PR (v1.2.0) enhances the CI/CD pipeline by adding automated GitHub releases and includes new unit tests for the SubtitleTranslator initialization. The changes primarily focus on GitHub Actions workflow modifications and test coverage improvements.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Enhanced GitHub Actions workflow to support automated releases
  • Renamed workflow from 'Release-pypi' to 'Release'
  • Added trigger for version tags (v*)
  • Added new GitHub release job that depends on PyPI deployment
  • Configured GitHub release action with softprops/action-gh-release
.github/workflows/Release.yml
Added unit tests for SubtitleTranslator initialization
  • Created new test function to verify constructor parameter assignments
  • Added assertions for model, API key, URLs, and access token properties
tests/test_translator.py
Bumped package version
  • Updated version from 1.1.2 to 1.2.0
pyproject.toml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

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

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟡 Testing: 1 issue found
  • 🟢 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 and I'll use the feedback to improve your reviews.

Comment on lines +10 to +19
def test_translator_sub_init() -> None:
translator = SubtitleTranslator(
torch_device=util.DEVICE,
whisper_model=util.MODEL_NAME,
model=util.OPENAI_MODEL,
api_key=util.OPENAI_API_KEY,
base_url=util.OPENAI_BASE_URL,
bangumi_url=util.BANGUMI_URL,
bangumi_access_token=util.BANGUMI_ACCESS_TOKEN,
)
Copy link

Choose a reason for hiding this comment

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

suggestion (testing): Test should verify error cases for invalid initialization parameters

The test only covers the happy path of initialization. Consider adding test cases for invalid parameters such as empty API keys, invalid URLs, or unsupported model names. This would help ensure the SubtitleTranslator handles initialization errors gracefully.

def test_translator_sub_init() -> None:
    with pytest.raises(ValueError):
        SubtitleTranslator(
            torch_device=util.DEVICE,
            whisper_model=util.MODEL_NAME,
            model=util.OPENAI_MODEL,
            api_key="",
            base_url="invalid_url",
            bangumi_url=util.BANGUMI_URL,
            bangumi_access_token=util.BANGUMI_ACCESS_TOKEN,
        )

@Tohrusky Tohrusky merged commit cf23616 into TensoRaws:main Dec 1, 2024
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.

None yet

1 participant