Skip to content

Commit

Permalink
[CI] adding a CODEOWNERS file
Browse files Browse the repository at this point in the history
  • Loading branch information
bclenet committed Feb 23, 2023
1 parent 53a0b88 commit 13c6c47
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 4 deletions.
7 changes: 7 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# CODEOWNERS - This file allows to assign owners to files of the repository.
# Each line consists in is a file pattern followed by one or more owners, or a team.
# See reference here : https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

# Files for CI-CD workflow management
.github/workflows/* @Inria-Empenn/narps_open_pipelines_admin
.gitlab-ci.yml @Inria-Empenn/narps_open_pipelines_admin
12 changes: 8 additions & 4 deletions docs/ci-cd.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,12 @@

## CI strategies

### Safety
- code owners for `.github/workflows` et `.gitlab-ci.yml`
### Security

Following [GitHub good security practices](https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions), and in order to avoid malicious code to be run through GitHub Actions workflows.


- The [CODEOWNERS](/.github/CODEOWNERS) file assigns "owners" for `.github/workflows` and `.gitlab-ci.yml` (see [CODEOWNERS reference](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)). This prevents unwanted changes to these files that are responsible for the CI-CD workflows.
- reviewing deployments / environments for CI-CD workflows (for local runners)
- environment `Empenn`
-
Expand All @@ -22,7 +26,7 @@

![Scheme of CI for NARPS open pipelines](/docs/assets/ci-scheme.svg)

## CI on GitHub
## :octopus: CI on GitHub

GitHub allows to launch CI workflows using [Actions](https://docs.github.com/en/actions).

Expand All @@ -36,6 +40,6 @@ These worflows are YAML files, located in the `.github/workflows/` directory. Fo
* **Where does it run ?** On GitHub servers.
* **How can I see the results ?** Outputs (logs of pylint) are stored as [downloadable artifacts](https://docs.github.com/en/actions/managing-workflow-runs/downloading-workflow-artifacts) during 15 days after the push.

## CI on GitLab
## :fox_face: CI on GitLab

A `.gitlab-ci.yml` file is provided in the repository as an example for contributors who would like to trigger [GitLab CI](https://docs.gitlab.com/ee/ci/) scripts from a [GitLab mirror repository](https://docs.gitlab.com/ee/user/project/repository/mirror/) of their fork of Inria-Empenn/narps_open_pipelines.

0 comments on commit 13c6c47

Please sign in to comment.