Migration to GitLab CI Components

README.md

@@ -9,14 +9,68 @@ Radiuss Shared CI allows project to share CI configuration for GitLab.
 
 ## Getting Started
 
-This project is meant to be hosted in a Gitlab instance so that other projects
-can import files from it to complete their CI configuration.
+This project is meant to be hosted in a GitLab instance so that other projects
+can use it to configure their CI pipelines.
+
+**As of v2025.12.0**, RADIUSS Shared CI is available as **GitLab CI Components** (requires GitLab 17.0+). This provides:
+
+- **Better versioning** through the GitLab CI/CD Catalog
+- **Type-safe inputs** with validated parameters
+- **Cleaner syntax** using `component:` instead of `include: project:`
+- **No more copy-pasting** - all templates are reusable components
 
 User documentation is located here: [**RADIUSS Shared CI Docs**](https://radiuss-shared-ci.readthedocs.io/en/latest/).
 
+### Quick Start with Components
+
+Add components to your `.gitlab-ci.yml`:
+
+```yaml
+# You must define stages (components don't define them to allow customization)
+stages:
+  - prerequisites
+  - build-and-test
+  - performance-measurements
+
+include:
+  # Base pipeline orchestration
+  - component: $CI_SERVER_FQDN/radiuss/radiuss-shared-ci/[email protected]
+    inputs:
+      github_project_name: "my-project"
+      github_project_org: "LLNL"
+      github_token: $GITHUB_TOKEN
+
+  # Machine-specific pipeline (choose the machines you need)
+  - component: $CI_SERVER_FQDN/radiuss/radiuss-shared-ci/[email protected]
+    inputs:
+      job_cmd: "./scripts/build-and-test.sh"
+      job_alloc: "1 -W 30"
+      github_project_name: "my-project"
+      github_project_org: "LLNL"
+```
+
+See the [examples/](examples/) directory for complete configuration examples.
+
+### Available Components
+
+- **base-pipeline** - Orchestration templates and machine availability checks
+- **lassen-pipeline** - Lassen supercomputer (LSF scheduler)
+- **dane-pipeline** - Dane supercomputer (SLURM scheduler)
+- **matrix-pipeline** - Matrix supercomputer (SLURM scheduler)
+- **corona-pipeline** - Corona supercomputer (flux scheduler)
+- **tioga-pipeline** - Tioga supercomputer (flux scheduler)
+- **tuolumne-pipeline** - Tuolumne supercomputer (flux scheduler)
+- **performance-pipeline** - Performance measurement and GitHub reporting
+- **utility-draft-pr-filter** - Skip CI on draft pull requests
+- **utility-branch-skip** - Skip CI on non-PR branches
+
+### Legacy Include-Based Approach
+
+The traditional include-based approach (using `pipelines/*.yml` and `utilities/*.yml`) is still available for GitLab versions < 17.0 or for projects that haven't yet migrated. See the documentation for migration guidance.
+
 ### Installing
 
-This project requires no installation.
+This project requires no installation. Components are consumed directly from the GitLab instance.
 
 ## Contributing
 

catalog-info.yml

@@ -0,0 +1,47 @@
+---
+# GitLab CI/CD Catalog metadata for RADIUSS Shared CI
+spec:
+  inputs:
+    # This catalog provides reusable components for RADIUSS projects
+    # See README.md for usage examples
+  components:
+    utility-draft-pr-filter:
+      description: >
+        Filters draft pull requests to skip CI execution until PR is marked ready.
+        Requires GitHub integration with GITHUB_TOKEN.
+    utility-branch-skip:
+      description: >
+        Skips CI execution on branches that are not associated with pull requests.
+        Requires GitHub integration with GITHUB_TOKEN.
+    base-pipeline:
+      description: >
+        Main pipeline setup component that orchestrates machine-specific child pipelines,
+        handles GitHub status reporting, and manages multi-machine CI execution.
+    corona-pipeline:
+      description: >
+        Corona specific CI pipeline component that runs build and test jobs.
+        Uses flux scheduler with shared allocation optimization.
+    tioga-pipeline:
+      description: >
+        Tioga specific CI pipeline component that runs build and test jobs.
+        Uses flux scheduler with shared allocation optimization.
+    tuolumne-pipeline:
+      description: >
+        Tuolumne specific CI pipeline component that runs build and test jobs.
+        Uses flux scheduler with shared allocation optimization.
+    dane-pipeline:
+      description: >
+        Dane specific CI pipeline component that runs build and test jobs.
+        Uses SLURM scheduler with shared allocation optimization.
+    matrix-pipeline:
+      description: >
+        Matrix specific CI pipeline component that runs build and test jobs.
+        Uses SLURM scheduler with shared allocation optimization.
+    lassen-pipeline:
+      description: >
+        Lassen specific CI pipeline component that runs build and test jobs.
+        Uses LSF scheduler.
+    performance-pipeline:
+      description: >
+        Performance measurement pipeline for running and tracking performance tests
+        across LLNL supercomputers.

customization/gitlab-ci.yml

@@ -37,12 +37,6 @@ variables:
 # Tells Gitlab to recursively update the submodules when cloning the project.
   GIT_SUBMODULE_STRATEGY: recursive
 
-##### PROJECT VARIABLES
-# We build the projects in the CI clone directory.
-# Used in script/gitlab/build_and_test.sh script.
-# TODO: add a clean-up mechanism.
-  BUILD_ROOT: ${CI_PROJECT_DIR}
-
 ##### SHARED_CI CONFIGURATION
 # Required information about GitHub repository
   GITHUB_PROJECT_NAME: "..."