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: add .tool-versions #37

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: add .tool-versions #37

wants to merge 2 commits into from

Conversation

JaeAeich
Copy link
Collaborator

@JaeAeich JaeAeich commented Nov 16, 2024

Description

Checklist

  • My code follows the contributing guidelines of this
    project, including, in particular, with regard to any style guidelines
  • The title of my PR complies with the Conventional Commits
    specification
    ; in particular, it clearly indicates
    that a change is a breaking change
  • I acknowledge that all my commits will be squashed into a single commit,
    using the PR title as the commit message
  • I have performed a self-review of my own code
  • I have commented my code in hard-to-understand areas
  • I have updated the user-facing documentation to describe any new or
    changed behavior
  • I have added type annotations for all function/class/method interfaces
    or updated existing ones (only for Python, TypeScript, etc.)
  • I have provided appropriate documentation (Google-style Python
    docstrings
    ) for all packages/modules/functions/classes/
    methods or updated existing ones
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature
    works
  • New and existing unit tests pass locally with my changes
  • I have not reduced the existing code coverage

Comments

Summary by Sourcery

Build:

  • Add a new Makefile target asdf-install to install tools specified in .tool-versions.

Copy link

sourcery-ai bot commented Nov 16, 2024

Reviewer's Guide by Sourcery

This pull request introduces a .tool-versions file and adds a new Makefile target to install the tools specified in this file. This improves environment management by automating the installation of required tools.

Sequence diagram for asdf-install Makefile target execution

sequenceDiagram
    participant User
    participant Make
    participant Shell
    participant ToolVersions

    User->>Make: make asdf-install (or make asdfi)
    Make->>ToolVersions: Read .tool-versions file
    ToolVersions-->>Make: Return installation commands
    Make->>Shell: Execute installation commands
    Shell-->>Make: Return execution status
    Make-->>User: Installation complete
Loading

File-Level Changes

Change Details Files
Added a new Makefile target to install tools from the .tool-versions file.
  • Created the asdf-install target to execute installation commands from the .tool-versions file.
  • Added a shortcut target asdfi for the asdf-install command.
  • Updated the help target to include information about the new asdf-install target and its shortcut asdfi.
{{ cookiecutter.project_name_dashed }}/Makefile
Introduced a .tool-versions file.
  • Created the .tool-versions file to store tool version information and installation commands.
{{ cookiecutter.project_name_dashed }}/.tool-versions

Assessment against linked issues

Issue Objective Addressed Explanation
#27 Streamline developer setup process by supporting .tool-versions for version management
#27 Leverage asdf as a version manager for project tools and languages
#27 Provide easy commands in Makefile for installing required tool versions

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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

Overall Comments:

  • The .tool-versions file appears to be empty. Please add the required tool version specifications to make this change functional.
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.

@JaeAeich
Copy link
Collaborator Author

Screenshot from 2024-11-16 16-07-57

@JaeAeich
Copy link
Collaborator Author

JaeAeich commented Jan 3, 2025

@sourcery-ai review

@JaeAeich
Copy link
Collaborator Author

JaeAeich commented Jan 3, 2025

@sourcery-ai summary

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

Overall Comments:

  • The .tool-versions file appears to be empty in the diff. Please include its intended contents so we can review the tool specifications.
  • Consider adding documentation about the expected format and usage of the '# INSTALL:' commands in .tool-versions, since this is a custom implementation.
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.

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.

imp: support .tool-versions
1 participant