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

--version points to git hash and date #755

Closed
wants to merge 1 commit into from

Conversation

dougsland
Copy link
Collaborator

@dougsland dougsland commented Feb 6, 2025

Today ramalama just share version 0.5.5 (as example) but don't tell users and developer which commit it's using.

Resolves: #754

Summary by Sourcery

Update the versioning scheme to use setuptools_scm, dynamically deriving the version from Git.

Build:

  • Use setuptools_scm for version management.

Chores:

  • Remove the hardcoded version and replace it with dynamic versioning.

Today ramalama just share version 0.5.5 (as example) but
don't tell users and developer which commit it's using.

Resolves: containers#754
Signed-off-by: Douglas Schilling Landgraf <[email protected]>
Copy link
Contributor

sourcery-ai bot commented Feb 6, 2025

Reviewer's Guide by Sourcery

This pull request modifies the version reporting mechanism to dynamically fetch the version from Git using setuptools_scm. This ensures that the version reported includes the git hash and date, providing more precise information about the commit being used.

Sequence diagram for the updated version reporting flow

sequenceDiagram
    participant User
    participant RamaLama
    participant Git

    User->>RamaLama: ramalama --version
    RamaLama->>Git: get_version()
    Git-->>RamaLama: return git hash and date
    RamaLama-->>User: display version with git info
Loading

Class diagram showing version module changes

classDiagram
    class version {
        +version()
        +print_version(args)
    }
    note for version "Changed from static version to dynamic Git-based versioning"

    class setuptools_scm {
        +get_version()
    }

    version ..> setuptools_scm : uses
Loading

File-Level Changes

Change Details Files
Replaced the static version with a dynamic version fetched from Git using setuptools_scm.
  • Removed the import of importlib.metadata.
  • Replaced the version function to use setuptools_scm.get_version().
  • Modified the print_version function to use an f-string for printing the version.
ramalama/version.py
Configured setuptools_scm to manage the package version.
  • Added build-system requirements for setuptools and setuptools_scm.
  • Added a build-backend specification.
  • Added a tool.setuptools_scm section.
pyproject.toml
Removed the hardcoded version and enabled setuptools_scm in setup.py.
  • Replaced the static version with use_scm_version=True.
setup.py

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!
  • 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
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 @dougsland - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider pinning the setuptools_scm version in pyproject.toml for reproducible builds.
  • Review behavior when not in a Git repository; a graceful fallback may be desirable if setuptools_scm can't determine the version.
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.

@dougsland dougsland marked this pull request as draft February 6, 2025 21:01
@dougsland
Copy link
Collaborator Author

#756

@dougsland dougsland closed this Feb 6, 2025
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.

ramalama version do not show git hash and date
1 participant