From e37567c2c0f8f43d8b8ac8a3e4bb78ecb688b018 Mon Sep 17 00:00:00 2001 From: Elango Cheran Date: Thu, 21 Mar 2024 15:27:19 -0700 Subject: [PATCH] ICU-22533 Update badges for CI pipelines, user guide docs about CI --- README.md | 5 +++-- docs/userguide/dev/ci.md | 13 ++++++++++--- 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7bdafa1ed6b3..42f736d8db37 100644 --- a/README.md +++ b/README.md @@ -17,11 +17,12 @@ Around March 24-25, 2021 we renamed the `master` branch to `main`. You may need Build | Status ------|------- -GitHub Actions | [![GHA CI](https://github.com/unicode-org/icu/workflows/GHA%20CI/badge.svg)](https://github.com/unicode-org/icu/actions?query=workflow%3A%22GHA+CI%22) +GitHub Actions (ICU4C) | [![GHA ICU4C](https://github.com/unicode-org/icu/workflows/GHA%20ICU4C/badge.svg)](https://github.com/unicode-org/icu/actions?query=workflow%3A%22GHA+ICU4C%22+branch%3Amain) +GitHub Actions (ICU4J) | [![GHA ICU4J](https://github.com/unicode-org/icu/workflows/GHA%20ICU4J/badge.svg)](https://github.com/unicode-org/icu/actions?query=workflow%3A%22GHA+ICU4J%22+branch%3Amain) Azure Pipelines (ICU4C) | [![Build Status](https://dev.azure.com/ms/icu/_apis/build/status/unicode-org/CI?branchName=main)](https://dev.azure.com/ms/icu/_build/latest?definitionId=360&branchName=main) Azure Pipelines (ICU4J) | [![Build Status](https://dev.azure.com/ms/icu/_apis/build/status%2Funicode-org%2FCI-ICU4J?branchName=main)](https://dev.azure.com/ms/icu/_build/latest?definitionId=631&branchName=main) Azure Pipelines (Exhaustive Tests) | [![Build Status](https://dev.azure.com/ms/icu/_apis/build/status/unicode-org/CI-Exhaustive-Main?branchName=main)](https://dev.azure.com/ms/icu/_build/latest?definitionId=361&branchName=main) -Azure Pipelines (Valgrind ICU4C) | [![Build Status](https://dev.azure.com/ms/icu/_apis/build/status/unicode-org/CI-Valgrind?branchName=main)](https://dev.azure.com/ms/icu/_build/latest?definitionId=364&branchName=main) +Github Actions (Valgrind) | [![GHA CI Valgrind]](https://github.com/unicode-org/icu/workflows/GHA%20CI%20Valgrind/badge.svg)](https://github.com/unicode-org/icu/actions/workflows/icu_valgrind.yml?query=workflow%3A%22GHA+CI%22+branch%3Amain) Fuzzing | [![Fuzzing Status](https://oss-fuzz-build-logs.storage.googleapis.com/badges/icu.svg)](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:icu) OpenSSF Scorecard | [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/unicode-org/icu/badge)](https://securityscorecards.dev/viewer/?uri=github.com/unicode-org/icu) diff --git a/docs/userguide/dev/ci.md b/docs/userguide/dev/ci.md index 986ede2dd8c1..90cac66a7ee2 100644 --- a/docs/userguide/dev/ci.md +++ b/docs/userguide/dev/ci.md @@ -55,7 +55,7 @@ Individual tests can be configured in the ICU Github repository: 7. If a new test (check) needs to be added, use the search box above the table and type the display name of the check, then click on it in the drop down list to add it to the table of required checks. -## Github Actions Configuration +## Github Actions ICU uses [Github Actions](https://github.com/features/actions) to run unit tests, environment tests, deployments of the User Guide, etc. @@ -109,7 +109,7 @@ the workflow will not run and Github is not capable of ignoring the check in tha Open Source users can now access machines with [at least 4 cores available per job](https://github.blog/2024-01-17-github-hosted-runners-double-the-power-for-open-source/). -## Azure Pipelines Configuration +## Azure Pipelines ICU also uses [Azure Pipelines](https://azure.microsoft.com/en-us/products/devops/pipelines) to run CI jobs. @@ -168,4 +168,11 @@ Note: The triggers for merges to a branch (ex: `main`) may need to be duplicated ### Caveats -In order to set up a pipeline, a person must simultaneously has access to the Azure Pipelines project for ICU and to the Github ICU repository. \ No newline at end of file +In order to set up a pipeline, a person must simultaneously have access to the Azure Pipelines project for ICU and to the Github ICU repository. + +If an Azure Pipeline only has one job, +that job might not be shown on a PR's main page within the list of all of the running CI checks. +There will only be an entry with the pipeline name in the list of checks. +However, if an Azure Pipeline has multiple jobs, +then each of the constituent jobs of the pipeline will be represent in the list of checks, +in addition to an entry for the pipeline itself. \ No newline at end of file