Skip to content

misc: Vagrantfile removal and missing pgi-docgen dependencies added to PythonDocs.Dockerfile#1130

Merged
vojtechtrefny merged 2 commits into
storaged-project:masterfrom
vojtechtrefny:master_misc-update
Oct 1, 2025
Merged

misc: Vagrantfile removal and missing pgi-docgen dependencies added to PythonDocs.Dockerfile#1130
vojtechtrefny merged 2 commits into
storaged-project:masterfrom
vojtechtrefny:master_misc-update

Conversation

@vojtechtrefny
Copy link
Copy Markdown
Member

No description provided.

The original idea was to use this for testing and development but
we never really did that and keeps getting out of date every 6
months.
@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello @vojtechtrefny, 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 refines the project's development and documentation infrastructure by removing the Vagrant configuration, suggesting a shift in how development environments are managed. Simultaneously, it enhances the robustness of the Python documentation build process by including essential development headers in the Dockerfile, resolving potential issues with 'pgi-docgen' dependency resolution.

Highlights

  • Vagrantfile Removal: The Vagrantfile, previously used for setting up development and testing environments for libblockdev, has been completely removed from the repository.
  • Python Documentation Dependencies: Missing development dependencies, specifically 'libgirepository1.0-dev' and 'gir1.2-glib-2.0-dev', have been added to the PythonDocs.Dockerfile to ensure the correct building of 'pgi-docgen'.
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
Copy Markdown

@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 removes the Vagrantfile, which appears to be an obsolete development environment configuration, and adds missing dependencies for pgi-docgen to the PythonDocs.Dockerfile. The changes are beneficial. I have provided one suggestion for the Dockerfile to improve its structure and follow best practices, which will enhance readability and reduce the final image size.


# pgi-docgen dependencies
RUN apt-get -y install python3 python3-pip python3-jinja2 python3-sphinx python3-bs4 python3-graphviz libgirepository-1.0-1 gir1.2-glib-2.0
RUN apt-get -y install python3 python3-pip python3-jinja2 python3-sphinx python3-bs4 python3-graphviz libgirepository-1.0-1 libgirepository1.0-dev gir1.2-glib-2.0 gir1.2-glib-2.0-dev
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

For better readability and to adhere to Dockerfile best practices, I suggest a few improvements:

  1. Split the long list of packages into multiple lines, sorted alphabetically. This improves maintainability.
  2. Add the --no-install-recommends flag to apt-get install to reduce the final image size.

As a future improvement for this file, consider combining all apt-get commands into a single RUN layer to optimize caching and further reduce image size.

RUN apt-get -y install --no-install-recommends \
    gir1.2-glib-2.0 \
    gir1.2-glib-2.0-dev \
    libgirepository-1.0-1 \
    libgirepository1.0-dev \
    python3 \
    python3-bs4 \
    python3-graphviz \
    python3-jinja2 \
    python3-pip \
    python3-sphinx

@vojtechtrefny vojtechtrefny merged commit 1483ed1 into storaged-project:master Oct 1, 2025
50 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.

2 participants