docs: add gitlab runner setup instructions#8
Conversation
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
Summary of ChangesHello, 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 enhances the project's documentation by providing comprehensive instructions for configuring a self-hosted GitLab CI/CD runner on macOS. This addition aims to facilitate continuous integration and deployment workflows for developers using GitLab, offering flexibility beyond GitHub Actions. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe 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
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 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
|
|
✅ SPDX check passed — all changed files include the required license header. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds documentation for setting up a self-hosted GitLab runner on macOS. The instructions are a good start, but have a couple of issues that could confuse users or lead to a suboptimal setup. Specifically, the manual download link points to an Intel (amd64) binary instead of the native Apple Silicon (arm64) one, which is the focus of this project. Additionally, the instructions for starting the runner don't account for the differences between a Homebrew installation and a manual one, which will cause commands to fail for users who chose the manual path. My review includes suggestions to correct the binary link and clarify the service startup process.
|
|
||
| **Option 2: Manual Download** | ||
| ```bash | ||
| sudo curl --output /usr/local/bin/gitlab-runner https://gitlab-runner-downloads.s3.amazonaws.com/latest/binaries/gitlab-runner-darwin-amd64 |
There was a problem hiding this comment.
This project focuses on Apple Silicon (M1/M2), but the download link provided is for the amd64 (Intel) architecture. For native performance on Apple Silicon, the arm64 binary should be used. While the amd64 binary can run via Rosetta 2, it's better to provide the native version.
| sudo curl --output /usr/local/bin/gitlab-runner https://gitlab-runner-downloads.s3.amazonaws.com/latest/binaries/gitlab-runner-darwin-amd64 | |
| sudo curl --output /usr/local/bin/gitlab-runner https://gitlab-runner-downloads.s3.amazonaws.com/latest/binaries/gitlab-runner-darwin-arm64 |
| gitlab-runner register --non-interactive \ | ||
| --url https://gitlab.com \ | ||
| --registration-token <TOKEN> \ | ||
| --description macos \ | ||
| --tag-list macos \ | ||
| --executor shell |
There was a problem hiding this comment.
Registering a system-wide runner (as implied by installing to /usr/local/bin) typically requires sudo to write the configuration file to a system directory like /etc/gitlab-runner/. Without sudo, the command may fail or create a user-specific configuration, which might not be what's intended for a service that runs system-wide.
| gitlab-runner register --non-interactive \ | |
| --url https://gitlab.com \ | |
| --registration-token <TOKEN> \ | |
| --description macos \ | |
| --tag-list macos \ | |
| --executor shell | |
| sudo gitlab-runner register --non-interactive \ | |
| --url https://gitlab.com \ | |
| --registration-token <TOKEN> \ | |
| --description macos \ | |
| --tag-list macos \ | |
| --executor shell |
| **Start and verify** | ||
| ```bash | ||
| gitlab-runner start | ||
| gitlab-runner verify | ||
| ``` |
There was a problem hiding this comment.
The gitlab-runner start command assumes the runner is installed as a service. This is handled automatically by the Homebrew installation, but not by the manual download steps. For users who followed the manual download, gitlab-runner start will fail because they first need to run gitlab-runner install.
To avoid confusion, it would be helpful to provide separate instructions for each installation method. For example:
**Start and Verify**
* **For Homebrew installations:**
The service is managed by `brew services`.
```bash
brew services start gitlab-runner
gitlab-runner verify
```
* **For manual installations:**
First, install the service, then start it.
```bash
sudo gitlab-runner install
sudo gitlab-runner start
gitlab-runner verify
```
|
✅ SPDX check passed — all changed files include the required license header. |
bniladridas
force-pushed
the
docs/gitlab-runner-setup
branch
from
f07a47c to
025ce56
Compare
|
✅ SPDX check passed — all changed files include the required license header. |
2 participants
Description
Adds instructions for setting up a self-hosted GitLab runner for CI/CD, including screenshot and step-by-step guide for Homebrew and manual installation methods.
Type of Change
Checklist
swiftc main.swift -framework Metal -o vector_addxcrun metal kernel.metalScreenshots (if applicable)