From 5b1af049749708bb35b8c025a60707b2013beff1 Mon Sep 17 00:00:00 2001 From: Aliya Nigamova Date: Thu, 25 Apr 2024 13:58:56 +0200 Subject: [PATCH 1/2] Add workflow description to contributing.md --- contributing.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/contributing.md b/contributing.md index 183ead29080..955aa60d6d2 100644 --- a/contributing.md +++ b/contributing.md @@ -109,6 +109,25 @@ Note that this will only affect your *local* copy of the gh-pages documentation. Please ensure you use relative paths. Currently, this is the only known feature where the behvaiour differs between local mkdocs and public page deployment. If you'd like to test the deployment directly, the suggested method is to set up a docs page using your personal github account; this should mimic the exact settings of the official page. +## Github Actions + +There are several automated processes defined in the [`.github/workflows`](https://github.com/cms-analysis/HiggsAnalysis-CombinedLimit/tree/main/.github/workflows) folder which are triggered for every pull request or when a new commit is pushed into the `main` branch. + + - `CI with CVMFS` workflow defined in [.github/workflows/cvmfs-ci.yml](https://github.com/cms-analysis/HiggsAnalysis-CombinedLimit/blob/main/.github/workflows/cvmfs-ci.yml) compiles Combine with the CMSSW which is setup from `cvmfs`. + - `CI/CD` workflow defined in [.github/workflows/ci.yml](https://github.com/cms-analysis/HiggsAnalysis-CombinedLimit/blob/main/.github/workflows/ci.yml) runs: + + 1. [Linting checks](https://github.com/cms-analysis/HiggsAnalysis-CombinedLimit/blob/main/.github/workflows/ci.yml#L11) with`flake8` and `black`. + 2. Combine compilation using conda environment with several combinations of (ROOT, python) versions: (6.26.4, 3.10), (6.24,3.9), (6.22, 3.9) and (6.22, 2.7.18) + + - `Docs` workflow defined in [.github/workflows/docs.yml](https://github.com/cms-analysis/HiggsAnalysis-CombinedLimit/blob/main/.github/workflows/docs.yml) manages the documentation deployment with `mike` as described above. + +In addition there are two conditional workflows that can be triggered with [github labels](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels): + +- `trigger gitlab job` workflow defined in [.github/workflows/gitlabci.yml](https://github.com/cms-analysis/HiggsAnalysis-CombinedLimit/blob/main/.github/workflows/gitlabci.yml) can be triggered with the image label. Please note that this gitlab workflow uses `CMSSW_10_2_13`, therefore it might fail with later versions of Combine and it is likely to be deprecated soon. + +- `Port to ` workflows defined in [.github/workflows/port_to_branch.yml](https://github.com/cms-analysis/HiggsAnalysis-CombinedLimit/blob/main/.github/workflows/port_to_branch.yml), e.g. the `Port to 112x-comb2022` can be triggered with the image label to port the changes from a pull request to the `112x-comb2022` branch and create a new pull request. + + ## Big Contributions We welcome large contributions to Combine. From d2bafd7e9279a3e93859236bceb17f1ada277f56 Mon Sep 17 00:00:00 2001 From: Aliya Nigamova Date: Mon, 29 Apr 2024 19:00:38 +0200 Subject: [PATCH 2/2] remove images --- contributing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/contributing.md b/contributing.md index 955aa60d6d2..2197854cbaa 100644 --- a/contributing.md +++ b/contributing.md @@ -123,9 +123,9 @@ There are several automated processes defined in the [`.github/workflows`](https In addition there are two conditional workflows that can be triggered with [github labels](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels): -- `trigger gitlab job` workflow defined in [.github/workflows/gitlabci.yml](https://github.com/cms-analysis/HiggsAnalysis-CombinedLimit/blob/main/.github/workflows/gitlabci.yml) can be triggered with the image label. Please note that this gitlab workflow uses `CMSSW_10_2_13`, therefore it might fail with later versions of Combine and it is likely to be deprecated soon. +- `trigger gitlab job` workflow defined in [.github/workflows/gitlabci.yml](https://github.com/cms-analysis/HiggsAnalysis-CombinedLimit/blob/main/.github/workflows/gitlabci.yml) can be triggered with the "safe to test" label. Please note that this gitlab workflow uses `CMSSW_10_2_13`, therefore it might fail with later versions of Combine and it is likely to be deprecated soon. -- `Port to ` workflows defined in [.github/workflows/port_to_branch.yml](https://github.com/cms-analysis/HiggsAnalysis-CombinedLimit/blob/main/.github/workflows/port_to_branch.yml), e.g. the `Port to 112x-comb2022` can be triggered with the image label to port the changes from a pull request to the `112x-comb2022` branch and create a new pull request. +- `Port to ` workflows defined in [.github/workflows/port_to_branch.yml](https://github.com/cms-analysis/HiggsAnalysis-CombinedLimit/blob/main/.github/workflows/port_to_branch.yml), e.g. the `Port to 112x-comb2022` can be triggered with the "port to 112x-comb2022" label to port the changes from a pull request to the `112x-comb2022` branch and create a new pull request. ## Big Contributions