fix (build): Add Buildifier to $PATH and include MODULE.bazel.lock

[vorburger]

Relates to #254.

[gemini-code-assist]

Hello @vorburger, I'm Gemini Code Assist¹! 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!

Summary of Changes

This pull request addresses issue #254 by making two key changes. First, it adds MODULE.bazel and MODULE.bazel.lock to the list of files that trigger the bazel-steward workflow. Second, it ensures that buildifier is available in the $PATH during the workflow execution by explicitly adding $HOME/go/bin to the $GITHUB_PATH.

Highlights

• Bazel Steward Configuration: The .bazel-steward.yaml file is updated to include MODULE.bazel and MODULE.bazel.lock files, ensuring that changes to these files trigger the Bazel Steward workflow.
• Buildifier in PATH: The bazel-steward.yaml workflow now explicitly adds $HOME/go/bin to the $GITHUB_PATH to ensure that buildifier is available for use during the workflow.

Changelog

• .bazel-steward.yaml
  • Added MODULE.bazel to line 36.
  • Added MODULE.bazel.lock to line 37.
• .github/workflows/bazel-steward.yaml
  • Added a step to print the current $PATH on line 44.
  • Added a step to add $HOME/go/bin to $GITHUB_PATH on line 46, ensuring buildifier is in the execution path.

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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

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 issue 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 is currently in preview and 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 to provide feedback.

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.

---

Did you know?

Bazel is named after the basilisk, a mythical reptile said to be king of the snakes, because it aims to be the king of build systems.

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. ↩

[gemini-code-assist]

Code Review

The pull request aims to add Buildifier to the $PATH and include MODULE.bazel.lock for bazel-steward. Overall, the changes seem reasonable, but there are a few points to consider.

Summary of Findings

• Adding Buildifier to $PATH: The method of adding Buildifier to the $GITHUB_PATH seems correct, but it's essential to ensure that this path is correctly configured in the environment for subsequent steps.
• Inclusion of MODULE.bazel.lock: Adding MODULE.bazel.lock to the list of files to be updated by bazel-steward is a good practice to keep dependencies consistent.

Merge Readiness

The changes seem generally good, but it's important to verify that the Buildifier installation and $PATH configuration are working as expected in the GitHub Actions environment. I am unable to approve this pull request, and users should have others review and approve this code before merging. I recommend that the pull request not be merged until the high severity issue is addressed.

[gemini-code-assist]

It's good to echo the $PATH to debug, but consider removing the echo $PATH line once you've confirmed that the path is being set correctly. Leaving it in adds noise to the workflow logs.

Also, it's generally better to use ::add-path command instead of directly manipulating $GITHUB_PATH for setting environment variables in GitHub Actions, as it's the recommended approach by GitHub. This is because ::add-path ensures that the path is correctly formatted and handled by the runner, and it also takes care of setting the path for both current and future steps in the job. Consider using echo "::add-path=$HOME/go/bin" instead.

          go install github.com/bazelbuild/buildtools/buildifier@latest
          echo "::add-path=$HOME/go/bin"

[vorburger]

This is just plain wrong! echo $(go env GOPATH)/bin >> "$GITHUB_PATH" may be better, according to https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#adding-a-system-path.