Enable Workspaces on 馃 nominatorbot
Description
As part of the broader effort to enable Workspaces across GitLab Engineering projects, we need to ensure that the Nominator Bot
To achieve this, we will:
- Identify any specific requirements for the Nominator Bot project (e.g., dependencies, runtime environment).
- Ensure that the necessary Workspaces infrastructure is provisioned.
- Configure the project with an appropriate devfile and container.
- Validate that Workspaces can be successfully launched and used for development in this project.
- Document the process for maintainers and users.
Justification
The Nominator Bot project was selected because it's one of the tools used actively by GitLab members. Even though it doesn't have a lot of contributors (primarily @ajrom
), I see instances where doing quick edits from the repo could be beneficial.
Acceptance Criteria
-
Ensure ruby and bundler are installed -
Ensure PostgreSQL database container is able to run within the Workspaces -
Create and configure an appropriate devfile for the project if required (the default GitLab devfile might be sufficient). -
Successfully launch a Workspace in the Nominator Bot project. -
Validate that bundle install
works as expected within the Workspace. -
Validate that bundle exec rspec
works as expected within the Workspace. -
Notify maintainer(s) and update relevant documentation in the project for users -
(Optional) Configure a VSCode task to auto setup the Workspace. This would take care of things like installing dependencies. See reference here and here to prevent errors locally. - Startup scripts for Remote Development workspac... (&15602) is the recommended way but this is still WIP.
Edited by Adebayo Adesanya