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

feat: update templates for FinalRip v0.3.x #49

Merged
merged 6 commits into from
Jan 31, 2025

Conversation

Tohrusky
Copy link
Member

@Tohrusky Tohrusky commented Jan 31, 2025

Summary by Sourcery

Update templates for FinalRip v0.3.x. Use os.getenv("FINALRIP_SOURCE") to get the real source file path in the FinalRip container. Use -i - to read from stdin and specify the output file path FINALRIP_ENCODED_CLIP.mkv.

Enhancements:

  • Update the default templates to use the new FinalRip v0.3.x API.

Documentation:

  • Document how to use templates for VS Script and Encode Param in FinalRip v0.3.x.

Copy link

sourcery-ai bot commented Jan 31, 2025

Reviewer's Guide by Sourcery

This pull request updates the templates for FinalRip v0.3.x. The templates now use more descriptive names and include a default h264 and hevc template.

Sequence diagram for updated FinalRip encoding process

sequenceDiagram
    participant VS as VS Script
    participant FFmpeg
    participant FS as File System
    VS->>VS: Read source from FINALRIP_SOURCE
    VS->>FFmpeg: Stream Y4M via pipe
    FFmpeg->>FFmpeg: Apply encoding parameters
    FFmpeg->>FS: Write to FINALRIP_ENCODED_CLIP.mkv
Loading

File-Level Changes

Change Details Files
Updated README.md to reflect the new template usage and naming conventions.
  • Updated the description of the template files.
  • Clarified the usage of environment variables in the templates.
  • Updated the example ffmpeg command to include the output file path.
  • Updated the example FinalRip command to include the output file path.
templates/README.md
Added new default templates for h264 and hevc encoding.
  • Added a default h264 template.
  • Added a default hevc template using ffmpeg.
  • Added a default hevc template using x265.
templates/default_h264_ffmpeg.txt
templates/default_hevc_ffmpeg.txt
templates/default_hevc_x265.txt
Removed the old web_anime_4k_h265_10bit.txt and default_h264.txt templates.
  • Removed the old web_anime_4k_h265_10bit.txt template.
  • Removed the old default_h264.txt template.
templates/web_anime_4k_h265_10bit.txt
templates/default_h264.txt

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. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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: 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 and I'll use the feedback to improve your reviews.

@Tohrusky Tohrusky merged commit fd30714 into TensoRaws:main Jan 31, 2025
1 check 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.

1 participant