Skip to content

Add nginx example usage#108

Merged
MusicalNinjaDad merged 13 commits into
mainfrom
example
Nov 13, 2025
Merged

Add nginx example usage#108
MusicalNinjaDad merged 13 commits into
mainfrom
example

Conversation

@MusicalNinjaDad

@MusicalNinjaDad MusicalNinjaDad commented Nov 13, 2025

Copy link
Copy Markdown
Owner

Summary by Sourcery

Introduce a complete nginx Docker example using snaggle, document it in the README, and extend the CI workflow to build and validate the new example.

Enhancements:

  • Add a concrete nginx example under examples/nginx demonstrating how to build a minimal image using snaggle

CI:

  • Update the test workflow to tag the CI image appropriately and to build and run the nginx example as part of checks

Documentation:

  • Expand README with an "Example usage" section showcasing the nginx Dockerfile

@sourcery-ai

sourcery-ai Bot commented Nov 13, 2025

Copy link
Copy Markdown

Reviewer's Guide

Adds a complete nginx usage example by updating the README, introducing example files, and extending CI to build and test the nginx scenario.

File-Level Changes

Change Details Files
Introduce Example usage section in README
  • Inserted a new “Example usage” header and context
  • Embedded a multi-stage Dockerfile snippet showing how to build nginx with snaggle
README.md
Add nginx example artifacts
  • Added a multi-stage installer/runtime Dockerfile for nginx
  • Provided a minimal nginx.conf
  • Provided a sample index.html
examples/nginx/Dockerfile
examples/nginx/nginx.conf
examples/nginx/index.html
Enhance CI workflow to test nginx example
  • Expanded container tags to include the published image
  • Added steps to build and load the nginx example image
  • Added run-and-curl test to verify nginx serves content
.github/workflows/test_docker.yml

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!

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

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location> `examples/nginx/nginx.conf:11-13` </location>
<code_context>
+http{
+    server {
+        location / {
+            root /data/www;
+        }
+    }
</code_context>

<issue_to_address>
**suggestion:** Consider specifying 'index' directive for default file serving.

Explicitly adding 'index index.html;' ensures consistent default file serving and prevents unexpected behavior.

```suggestion
        location / {
            root /data/www;
            index index.html;
        }
```
</issue_to_address>

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 thread examples/nginx/nginx.conf
@codecov

codecov Bot commented Nov 13, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.47%. Comparing base (d7b8f97) to head (14f33f5).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #108   +/-   ##
=======================================
  Coverage   76.47%   76.47%           
=======================================
  Files          13       13           
  Lines         748      748           
=======================================
  Hits          572      572           
  Misses        119      119           
  Partials       57       57           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@MusicalNinjaDad MusicalNinjaDad enabled auto-merge (squash) November 13, 2025 12:48
@MusicalNinjaDad MusicalNinjaDad merged commit d6da66d into main Nov 13, 2025
18 checks passed
@MusicalNinjaDad MusicalNinjaDad deleted the example branch November 13, 2025 12:49
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