Merge branch 'dev-gitlab-triage-gem' into 'main'

feat(image): add image that wraps the gitlab triage gem

See merge request !1

.gitignore

@@ -160,3 +160,7 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+# Ruby vendor artifacts
+vendor/bundle
+.bundle

Dockerfile

+###############################################################################
+# `base` image for all downstream images to build upon.
+# Make sure the ruby version matches the version in the Gemfile.
 FROM ruby:3.0.7-slim AS base
 
-CMD ["sh", "-c", "echo 'Application running'"]
+RUN set -eux; \
+    apt-get -q update; \
+    DEBIAN_FRONTEND=noninteractive apt-get -qy install ruby-dev build-essential
+
+RUN gem install bundler
+
+WORKDIR /usr/src/app
+
+###############################################################################
+# `install-deps` image inside which the gitlab-triage gem is installed. The `install-deps` image is
+# separate from the `base` image so the `base` image can be used to regenerate the `Gemfile.lock` file.
+FROM base AS install-deps
+
+# Install `gitlab-triage` from a `Gemfile` to allow Renovate-it to keep the gem fresh.
+COPY Gemfile Gemfile.lock ./
+RUN bundle install --path vendor/bundle
+
+ENV GITLAB_TOKEN=""
+ENV GITLAB_URL=""
+ENV TRIAGE_SOURCE_ID=""
+ENV TRIAGE_SOURCE_TYPE=""
+ENV TRIAGE_POLICY_FILE=""
+
+###############################################################################
+# A development focused image that does not include the triage policies since these are mounted
+# as a volume.
+FROM install-deps AS development
+
+CMD ["sh", "-c", "bundle exec gitlab-triage --dry-run --token ${GITLAB_TOKEN} --host-url ${GITLAB_URL} --source ${TRIAGE_SOURCE_TYPE} --source-id ${TRIAGE_SOURCE_ID} --policies-file ${TRIAGE_POLICY_FILE}"]
+
+###############################################################################
+# The last target is the "default" one and in our case the `production` image that includes all
+# triage policies copied from `triage-policies/`.
+FROM install-deps AS production
+
+COPY triage-policies/ triage-policies/
+
+CMD ["sh", "-c", "bundle exec gitlab-triage --dry-run --token ${GITLAB_TOKEN} --host-url ${GITLAB_URL} --source ${TRIAGE_SOURCE_TYPE} --source-id ${TRIAGE_SOURCE_ID} --policies-file ${TRIAGE_POLICY_FILE}"]

Gemfile

+source 'https://rubygems.org'
+
+# Make sure the ruby version matches the version in the Dockerfile.
+ruby '3.0.7'
+
+gem 'gitlab-triage', '~> 1.44', '>= 1.44.3'

Gemfile.lock

+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.1.5.1)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      mutex_m
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0)
+    base64 (0.2.0)
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.0)
+    drb (2.2.1)
+    gitlab-triage (1.44.3)
+      activesupport (>= 5.1)
+      globalid (~> 1.0, >= 1.0.1)
+      graphql (< 2.1.0)
+      graphql-client (~> 0.16)
+      httparty (~> 0.20.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    graphql (2.0.31)
+      base64
+    graphql-client (0.25.0)
+      activesupport (>= 3.0)
+      graphql (>= 1.13.0)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    logger (1.6.6)
+    mime-types (3.6.0)
+      logger
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2025.0304)
+    minitest (5.25.4)
+    multi_xml (0.6.0)
+    mutex_m (0.3.0)
+    securerandom (0.3.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  aarch64-linux
+  ruby
+
+DEPENDENCIES
+  gitlab-triage (~> 1.44, >= 1.44.3)
+
+RUBY VERSION
+   ruby 3.0.7p220
+
+BUNDLED WITH
+   2.5.23

README.md

 # GitLab Triage
 
 GitLab Triage provides a wrapper for the [`gitlab-triage`](https://gitlab.com/gitlab-org/ruby/gems/gitlab-triage) gem, enabling automated triage of issues, merge requests and epics based on a triage policy.
+
+## Settings
+
+The following settings are used to configure the `gitlab-triage` tool:
+
+* `GITLAB_TOKEN` a valid GitLab API token. When running in local development, generate your own [GitLab Personal Access Token](https://docs.gitlab.com/user/profile/personal_access_tokens/).
+* `GITLAB_URL` a valid GitLab host URL. For UIS DevOps the host is `https://gitlab.developers.cam.ac.uk/`
+* `TRIAGE_SOURCE_ID` the id of the target GitLab `project` or `group`.
+* `TRIAGE_SOURCE_TYPE` can be either `projects` or `groups` corresponding to the associated `TRIAGE_SOURCE_ID`.
+* `TRIAGE_POLICY_FILE` a YAML file containing a valid triage policy.
+
+## Local Development
+
+We use pre-commit to check linting locally and in the CI pipeline. Before you can run pre-commit hooks locally, you need to have the pre-commit package manager installed:
+
+```sh
+pip install pre-commit
+```
+
+Following this, install the pre-commit hooks locally by running:
+
+```sh
+pre-commit install
+```
+
+The local development environment uses the settings loaded from `local-dev-settings.env`. You will need to generate your own [GitLab Personal Access Token](https://docs.gitlab.com/user/profile/personal_access_tokens/) store this new token in your own 1Password vault and update `GITLAB_TOKEN` in `local-dev-settings.env` to the 1Password secret reference pointing to the new token.
+
+We include a working example triage policy `./triage-policies/example-triage-policy.yml` that operates on project `uis/devops/experiments/av603/misc`. When developing you own triage policy, refer to the field names defined in [`gitlab-triage`](https://gitlab.com/gitlab-org/ruby/gems/gitlab-triage) and ensure the policy only affects the intended `TRIAGE_SOURCE_ID` by limiting the project path. For example:
+
+```yaml
+ruby:
+    "project_path.include?('uis/devops/experiments/av603/misc')"
+```
+
+If the `gitlab-triage` gem becomes stale, the version can be refreshed by updating the target version inside the `Gemfile` and regenerating the `Gemfile.lock`. To update the `Gemfile.lock` you can either install the target version of `Ruby` and `bundler` on your local machine and run `bundle install`:
+
+```sh
+brew install ruby@3.0
+gem install bundler --user-install
+bundle install --path vendor/bundle
+```
+
+OR by building an image from the `base` target, mount the working directory containing the `Gemfile` inside a container and running `bundle install` from within the container:
+
+```sh
+docker build --target base -t gitlab-triage-base:latest .
+docker run -it -v "$(pwd):/usr/src/app" -w /usr/src/app gitlab-triage-base:latest /bin/bash
+bundle install --path vendor/bundle
+```

docker-compose.yml

+name: gitlab-triage
+services:
+  bot:
+    build:
+      context: .
+      target: development
+      dockerfile: Dockerfile
+    environment:
+    - GITLAB_TOKEN=${GITLAB_TOKEN}
+    - GITLAB_URL=${GITLAB_URL}
+    - TRIAGE_SOURCE_ID=${TRIAGE_SOURCE_ID}
+    - TRIAGE_SOURCE_TYPE=${TRIAGE_SOURCE_TYPE}
+    - TRIAGE_POLICY_FILE=${TRIAGE_POLICY_FILE}
+    volumes:
+      - ./triage-policies/:/usr/src/app/triage-policies/:ro

local-dev-settings.env

+# local-dev-settings.env defines the non-secret and secret settings used in local development.
+########    DO NOT ADD LIVE SECRETS TO THIS FILE    ########
+
+## Non-secret settings used for local development.
+GITLAB_URL=https://gitlab.developers.cam.ac.uk/
+TRIAGE_POLICY_FILE=/usr/src/app/triage-policies/example-triage-policy.yml
+TRIAGE_SOURCE_TYPE=projects
+TRIAGE_SOURCE_ID=8102
+
+## Secret setting fetched via secret reference from 1Password vault
+GITLAB_TOKEN=op://45sjtta2zimlwdnsbbrnabsjqy/hpeubzrp556f27oamxqoakfrdq/credential

run-gitlab-triage.sh

+#!/bin/bash
+# run-gitlab-triage.sh starts the GitLab Triage docker stack. Reads environmental variables and
+# 1Password secret references defined in `local-dev-settings.env` and injects them into the running
+# container.
+
+eval $(op signin --account=uis-devops.1password.eu)
+op run --no-masking --env-file "./local-dev-settings.env" -- ${@:-docker compose up --build}

triage-policies/example-triage-policy.yml

+# example-triage-policies.yml contains example gitlab triage policies targeting Gitlab repository
+# `uis/devops/experiments/av603/misc`
+
+resource_rules:
+  issues:
+    rules:
+
+      # Add the `team::Holberton` label if no other `team::` scoped label is present.
+      - name: Add default `team::` label
+        conditions:
+          state: opened
+          forbidden_labels:
+            - team::Authentication
+            - team::Cloud
+            - team::DevOps
+            - team::Drupal
+            - team::Hamilton
+            - team::Holberton
+            - team::Identity
+            - team::Jackson
+            - team::Johnson
+            - team::Lovelace
+          ruby:
+            "project_path.include?('uis/devops/experiments/av603/misc')"
+        actions:
+          labels:
+            - team::Holberton
+
+      # Add default `priority::2 Medium` label if no other `priority::` scoped label is present.
+      - name: Add default `priority::` label
+        conditions:
+          state: opened
+          forbidden_labels:
+            - priority::0 Highest
+            - priority::1 High
+            - priority::2 Medium
+            - priority::3 Low
+            - priority::4 Lowest
+          ruby:
+            "project_path.include?('uis/devops/experiments/av603/misc')"
+        actions:
+          labels:
+            - priority::2 Medium
+
+      # Add default `issuetype::Task` label if no other `issuetype::` scoped label is present.
+      # All `issuetype::` scoped labels not listed in `forbidden_labels` are specifically excluded
+      # and default to `issuetype::Task`.
+      - name: Add default `issuetype::` label
+        conditions:
+          state: opened
+          forbidden_labels:
+            - issuetype::Bug
+            - issuetype::Incident
+            - issuetype::SubTask
+            - issuetype::Task
+            - issuetype::User Story
+          ruby:
+            "project_path.include?('uis/devops/experiments/av603/misc')"
+        actions:
+          labels:
+            - issuetype::Task

triage-policies/holberton-triage-policy.yml

+# holberton-triage-policy.yml contains the default gitlab triage policy used for the Holberton team.
+
+resource_rules:
+  issues:
+    rules:
+
+      # Add the `team::Holberton` label if no other `team::` scoped label is present.
+      - name: Add default `team::` label
+        conditions:
+          state: opened
+          forbidden_labels:
+            - team::Authentication
+            - team::Cloud
+            - team::DevOps
+            - team::Drupal
+            - team::Hamilton
+            - team::Holberton
+            - team::Identity
+            - team::Jackson
+            - team::Johnson
+            - team::Lovelace
+          ruby:
+            "project_path.include?('uis/devops/hr') || project_path.include?('uis/devops/finance')"
+        actions:
+          labels:
+            - team::Holberton
+
+      # Add default `priority::2 Medium` label if no other `priority::` scoped label is present.
+      - name: Add default `priority::` label
+        conditions:
+          state: opened
+          forbidden_labels:
+            - priority::0 Highest
+            - priority::1 High
+            - priority::2 Medium
+            - priority::3 Low
+            - priority::4 Lowest
+          ruby:
+            "project_path.include?('uis/devops/hr') || project_path.include?('uis/devops/finance')"
+        actions:
+          labels:
+            - priority::2 Medium
+
+      # Add default `issuetype::Task` label if no other `issuetype::` scoped label is present.
+      # All `issuetype::` scoped labels not listed in `forbidden_labels` are specifically excluded
+      # and default to `issuetype::Task`.
+      - name: Add default `issuetype::` label
+        conditions:
+          state: opened
+          forbidden_labels:
+            - issuetype::Bug
+            - issuetype::Incident
+            - issuetype::SubTask
+            - issuetype::Task
+            - issuetype::User Story
+          ruby:
+            "project_path.include?('uis/devops/hr') || project_path.include?('uis/devops/finance')"
+        actions:
+          labels:
+            - issuetype::Task