Skip to content

Conversation

abhibongale
Copy link
Contributor

@abhibongale abhibongale commented Sep 18, 2025

Added the docker-compose.yaml example and updated the type option table with compose option.

fixes: #1872

Summary by Sourcery

Document Compose file generation support in the CLI man page

Documentation:

  • Add 'compose' as a supported output type in the generate option table
  • Include a detailed example of generating a docker-compose.yaml file with ramalama serve

Added the docker-compose.yaml example and updated the type option table
with compose option.

fixes: containers#1872
Signed-off-by: Abhishek Bongale <[email protected]>
Copy link
Contributor

sourcery-ai bot commented Sep 18, 2025

Reviewer's Guide

This PR updates the ramalama-serve manual page to document the new 'compose' generate option by adding it to the type table and providing a dedicated example section with a sample docker-compose.yaml.

Class diagram for updated type option table in ramalama serve

classDiagram
    class TypeOptionTable {
      +quadlet
      +kube
      +quadlet/kube
      +compose
    }
Loading

File-Level Changes

Change Details Files
Added 'compose' as a new generation option in the CLI documentation
  • Inserted 'compose' entry into the type option table
  • Updated table formatting to include the new option
docs/ramalama-serve.1.md
Provided a 'Generate Compose file' example section
  • Added a new heading and code block demonstrating the CLI command
  • Included sample docker-compose.yaml output in the docs
docs/ramalama-serve.1.md

Possibly linked issues


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

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Summary of Changes

Hello @abhibongale, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the ramalama serve command's documentation by integrating support for Docker Compose. It provides users with a new, clear method to generate docker-compose.yaml files, facilitating the deployment of AI models as services using Docker Compose, thereby expanding the available deployment options.

Highlights

  • Compose Documentation Added: This pull request introduces comprehensive documentation for using Docker Compose with the ramalama serve command.
  • New --generate Option: The ramalama-serve.1.md file has been updated to include compose as a valid option for the --generate flag, enabling the creation of Compose YAML definitions.
  • Docker Compose Example: A new section demonstrating how to generate a docker-compose.yaml file for running an AI model as a service has been added, complete with command examples and the resulting YAML structure.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

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


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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds documentation for generating docker-compose.yaml files. The changes are a good addition, but I've found a couple of issues in the example docker-compose.yaml provided in the documentation. The command seems to be conceptually incorrect, and a volume path uses a non-portable ~. I've provided suggestions to improve the example to make it more correct and robust.

Copy link
Member

@engelmi engelmi left a comment

Choose a reason for hiding this comment

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

LGTM

@engelmi engelmi merged commit 6ea8f89 into containers:main Sep 18, 2025
10 of 25 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.

Add documentation for compose support in --help and man pages
2 participants