Skip to content

Commit 20c6964

Browse files
authored
25.12 updated Maintainer Docs - GitHub Actions (#722)
* 25.12 updated Maintainer Docs - GitHub Actions * updated to use main instead of release/25.12
1 parent d1a95b9 commit 20c6964

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

resources/github-actions.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -41,21 +41,21 @@ Finally, the page [here](https://docs.gha-runners.nvidia.com/runners/) outlines
4141

4242
Every RAPIDS repository using GitHub Actions has, at a minimum, the following three GitHub Action workflow files:
4343

44-
- `pr.yaml` - [rmm workflow example](https://github.com/rapidsai/rmm/blob/branch-23.12/.github/workflows/pr.yaml), [rmm workflow run history](https://github.com/rapidsai/rmm/actions/workflows/pr.yaml)
45-
- `build.yaml` - [rmm workflow example](https://github.com/rapidsai/rmm/blob/branch-23.12/.github/workflows/build.yaml), [rmm workflow run history](https://github.com/rapidsai/rmm/actions/workflows/build.yaml)
46-
- `test.yaml` - [rmm workflow example](https://github.com/rapidsai/rmm/blob/branch-23.12/.github/workflows/test.yaml), [rmm workflow run history](https://github.com/rapidsai/rmm/actions/workflows/test.yaml)
44+
- `pr.yaml` - [rmm workflow example](https://github.com/rapidsai/rmm/blob/main/.github/workflows/pr.yaml), [rmm workflow run history](https://github.com/rapidsai/rmm/actions/workflows/pr.yaml)
45+
- `build.yaml` - [rmm workflow example](https://github.com/rapidsai/rmm/blob/main/.github/workflows/build.yaml), [rmm workflow run history](https://github.com/rapidsai/rmm/actions/workflows/build.yaml)
46+
- `test.yaml` - [rmm workflow example](https://github.com/rapidsai/rmm/blob/main/.github/workflows/test.yaml), [rmm workflow run history](https://github.com/rapidsai/rmm/actions/workflows/test.yaml)
4747

4848
These GitHub Actions workflow files contain a description of all the automated jobs that run as a part of the workflow.
4949

5050
These jobs contain things like C++/Python builds, C++/Python tests, notebook tests, etc.
5151

5252
The chart below provides an overview of how each workflow file is used.
5353

54-
| Event: | Runs workflows: | Performs Builds? | Performs Tests? | Uploads to Anaconda.org/Wheel Registry? |
55-
| --------------------------------- | ------------------------------- | :--------------: | :-------------: | :-------------------------------------: |
56-
| - PRs | - `pr.yaml` ||||
57-
| - `branch-*` Merges<br>- Releases | - `build.yaml` ||||
58-
| - Nightlies | - `build.yaml`<br>- `test.yaml` ||||
54+
| Event: | Runs workflows: | Performs Builds? | Performs Tests? | Uploads to Anaconda.org/Wheel Registry? |
55+
| ---------------------------------- | ------------------------------- | :--------------: | :-------------: | :-------------------------------------: |
56+
| - PRs | - `pr.yaml` ||||
57+
| - `release/*` Merges<br>- Releases | - `build.yaml` ||||
58+
| - Nightlies | - `build.yaml`<br>- `test.yaml` ||||
5959

6060
Although release workflows don't run tests, they do go through a week of nightly testing to ensure everything works as expected. See [this page]({% link releases/process.md %}) for more details about the release process.
6161

@@ -105,9 +105,9 @@ The `GPUtester` account is a system account used to trigger nightly workflow run
105105
RAPIDS uses a collection of reusable GitHub Actions workflows in order to single-source common build configuration settings.
106106
These reusable workflows can be found in the [rapidsai/shared-workflows](https://github.com/rapidsai/shared-workflows) repository.
107107

108-
An example of one of the reusable workflows used by RAPIDS is the [`conda-cpp-build.yaml` workflow](https://github.com/rapidsai/shared-workflows/blob/branch-25.08/.github/workflows/conda-cpp-build.yaml), which is the source of truth for which architectures and CUDA versions build RAPIDS C++ packages.
108+
An example of one of the reusable workflows used by RAPIDS is the [`conda-cpp-build.yaml` workflow](https://github.com/rapidsai/shared-workflows/blob/main/.github/workflows/conda-cpp-build.yaml), which is the source of truth for which architectures and CUDA versions build RAPIDS C++ packages.
109109

110-
Similarly, the [`conda-cpp-tests.yaml` workflow](https://github.com/rapidsai/shared-workflows/blob/branch-25.08/.github/workflows/conda-cpp-tests.yaml) specifies configurations for testing RAPIDS C++ packages.
110+
Similarly, the [`conda-cpp-tests.yaml` workflow](https://github.com/rapidsai/shared-workflows/blob/main/.github/workflows/conda-cpp-tests.yaml) specifies configurations for testing RAPIDS C++ packages.
111111

112112
The majority of these reusable workflows leverage the CI images from the [rapidsai/ci-imgs](https://github.com/rapidsai/ci-imgs/) repository.
113113

@@ -176,14 +176,14 @@ Those URLs are of the form `https://github.com/{org}/{repo}/actions/runs/{workfl
176176
Valid values for `{artifact-name}` can be found on the "Actions" tab in the GitHub Actions UI, as described in "Finding Artifacts in the GitHub UI" above.
177177
The run IDs can also be identified programmatically.
178178

179-
For example, the following sequence of commands accomplishes the task *"download the latest `rmm` Python 3.12, CUDA 12 conda packages built from `branch-25.08`"*.
179+
For example, the following sequence of commands accomplishes the task *"download the latest `rmm` Python 3.12, CUDA 12 conda packages built from `main`"*.
180180

181181
```shell
182-
# get the most recent successful branch-25.08 nightly or branch build
182+
# get the most recent successful main nightly or branch build
183183
RUN_ID=$(
184184
gh run list \
185185
--repo "rapidsai/rmm" \
186-
--branch "branch-25.08" \
186+
--branch "main" \
187187
--workflow "build.yaml" \
188188
--status "success" \
189189
--json "createdAt,databaseId" \
@@ -215,14 +215,14 @@ To use these:
215215
* download them to local directories using the `gh` CLI
216216
* pass the paths to those directories as channels via `--channel` to `conda` / `mamba` commands
217217

218-
For example, to create a conda environment that uses the latest `librmm` and `rmm` conda packages built from `branch-25.08` on an x86_64, CUDA 12 system:
218+
For example, to create a conda environment that uses the latest `librmm` and `rmm` conda packages built from `main` on an x86_64, CUDA 12 system:
219219

220220
```shell
221221
# get the most recent successful nightly or branch build
222222
RUN_ID=$(
223223
gh run list \
224224
--repo "rapidsai/rmm" \
225-
--branch "branch-25.08" \
225+
--branch "main" \
226226
--workflow "build.yaml" \
227227
--status 'success' \
228228
--json 'createdAt,databaseId' \
@@ -309,7 +309,7 @@ To use these:
309309
* download them to local directories using the `gh` CLI
310310
* pass the paths to wheels in those directories to installers like `pip` or `uv`
311311

312-
For example, to create a virtual environment with `librmm` and `rmm` packages built from `branch-25.08` on an x86_64, CUDA 12 system:
312+
For example, to create a virtual environment with `librmm` and `rmm` packages built from `main` on an x86_64, CUDA 12 system:
313313

314314
```shell
315315
# create virtualenv
@@ -320,7 +320,7 @@ source ./rmm-test-env/bin/activate
320320
RUN_ID=$(
321321
gh run list \
322322
--repo "rapidsai/rmm" \
323-
--branch "branch-25.08" \
323+
--branch "main" \
324324
--workflow "build.yaml" \
325325
--status 'success' \
326326
--json 'createdAt,databaseId' \

0 commit comments

Comments
 (0)