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.

Sign up for GitHub

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

Jump to bottom

feat: add .tool-versions #37

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add .tool-versions #37

wants to merge 1 commit into from

Conversation

JaeAeich
Copy link
Collaborator

@JaeAeich JaeAeich commented Nov 16, 2024 •
edited by sourcery-ai bot
Loading

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

Add a .tool-versions file and update the Makefile to include a new target for installing tools specified in this file, enhancing environment management.

New Features:

  • Introduce a new Makefile target 'asdf-install' to automate the installation of tools specified in the .tool-versions file.

Enhancements:

  • Add a shortcut target 'asdfi' in the Makefile for the 'asdf-install' command.

@sourcery-ai Sourcery AI
Copy link

sourcery-ai bot commented Nov 16, 2024 •
edited
Loading

Reviewer's Guide by Sourcery

This PR adds support for asdf version manager by introducing a .tool-versions file and adding corresponding Makefile targets to handle tool installation. The implementation adds two new make targets (asdf-install and its alias asdfi) that parse and execute installation commands from the .tool-versions file.

Class diagram for Makefile changes

classDiagram
    class Makefile {
        +help()
        +asdf-install()
        +asdfi()
        +clean-venv()
        +install()
        +venv()
    }
    note for Makefile "Added asdf-install and asdfi targets for tool installation."
Loading

File-Level Changes

Change Details Files
Added asdf version manager support with new Makefile targets
  • Added new make target 'asdf-install' that reads and executes installation commands from .tool-versions
  • Created alias 'asdfi' for the asdf-install target
  • Added help text for the new asdf-install target
  • Added empty .tool-versions file for future tool version specifications
 {{ cookiecutter.project_name_dashed }}/Makefile
{{ cookiecutter.project_name_dashed }}/.tool-versions

Assessment against linked issues

Issue Objective Addressed Explanation
#27 Add support for .tool-versions file to manage tool versions with asdf ✅
#27 Add Makefile integration for easy tool installation ✅

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

sourcery-ai[bot]
sourcery-ai bot reviewed Nov 16, 2024
View reviewed changes
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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

imp: support .tool-versions
1 participant
@JaeAeich