Skip to content

docs: add asdf installation instructions#296

Open
sonwr wants to merge 5 commits intogoogleworkspace:mainfrom
sonwr:docs/asdf-installation-264
Open

docs: add asdf installation instructions#296
sonwr wants to merge 5 commits intogoogleworkspace:mainfrom
sonwr:docs/asdf-installation-264

Conversation

@sonwr
Copy link

@sonwr sonwr commented Mar 7, 2026

Adds an asdf installation option to the README Installation section, based on the plugin shared in #264.

  • add plugin setup command
  • add list/install/set commands

Validation:

  • git diff --check

Closes #264

@changeset-bot
Copy link

changeset-bot bot commented Mar 7, 2026

⚠️ No Changeset found

Latest commit: 152f1c9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, 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 expands the installation documentation for the Google Workspace CLI by integrating asdf as an additional method. This enhancement aims to improve accessibility for users who prefer or already utilize asdf for managing their development environment tools, offering a more flexible installation pathway.

Highlights

  • asdf Installation Instructions: Added a new section to the README providing detailed instructions for installing the Google Workspace CLI using asdf, including commands for adding the plugin, listing versions, installing, and setting the global version.
Changelog
  • README.md
    • Added a new installation option for asdf users.
    • Included specific bash commands for plugin setup, version listing, installation, and global setting.
Activity
  • No specific activity (comments, reviews, or progress updates) has been provided in the context for this pull request.
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 Generative AI Prohibited Use Policy, 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

@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 installation instructions for asdf to the README.md file. While adding more installation options is great, one of the provided commands is incorrect. I've suggested a correction to use the current, standard asdf command. Additionally, for user transparency and security, I've recommended clarifying that the asdf plugin is community-maintained.

@sonwr
Copy link
Author

sonwr commented Mar 7, 2026

Thanks for the review — great catches. I updated both points in 7405c01:

  • Clarified that the asdf plugin is community-maintained.
  • Replaced deprecated asdf set --home with asdf global for global installation.

I also resolved both review threads.

@googleworkspace-bot
Copy link
Collaborator

/gemini review

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 installation instructions for asdf. The change itself is straightforward, but it introduces a reference to a third-party, community-maintained plugin. My review includes a high-severity security comment recommending the addition of an explicit warning to mitigate potential supply chain risks associated with promoting a non-official plugin within a googleworkspace project.

@sonwr
Copy link
Author

sonwr commented Mar 7, 2026

Thanks — agreed on the supply-chain risk framing. I added an explicit warning block in README (commit 0ecda9d) clarifying that asdf-gws is community-maintained, not officially vetted/supported by Google, and should be reviewed before use.

I also resolved the thread.

@googleworkspace-bot
Copy link
Collaborator

/gemini review

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 a new installation option using asdf to the README.md. The instructions are clear and provide a good starting point for users who prefer this version manager. I have one suggestion to improve the reproducibility of the environment by pinning to a specific version instead of using a floating 'latest' tag, which can prevent unexpected breakages for users.

@googleworkspace-bot
Copy link
Collaborator

/gemini review

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 instructions for installing the gws CLI using asdf. The changes are in the README.md file. My review focuses on the correctness and clarity of the provided commands. I've identified an issue where the instructions can be misleading if a user wants to install a specific version, and I've suggested a change to make the instructions clearer and more robust by separating the use cases for installing the latest versus a specific version.

@sonwr
Copy link
Author

sonwr commented Mar 7, 2026

Great point — fixed in follow-up commit 152f1c9.\n\nI split the asdf section into two explicit paths:\n- install/pin latest\n- install/pin a specific version\n\nThis avoids implying that should always set when a user intends to pin a specific version.

@sonwr
Copy link
Author

sonwr commented Mar 7, 2026

Quick clarification (my previous comment lost inline code formatting): the ambiguity was around asdf global gws $(asdf latest gws) being interpreted as the default even when the user intends to pin a specific version. The README now separates latest vs specific-version flows explicitly in 152f1c9.

@googleworkspace-bot
Copy link
Collaborator

/gemini review

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 installation instructions for asdf to the README.md file. The new section includes a warning about the community-maintained nature of the plugin and provides clear commands for installation. The changes are well-documented and I found no issues that meet the high or critical severity threshold requested for this review.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Installation via asdf using plugin

2 participants