chore: add license header and compatibilities checks in CI (#56)

Signed-off-by: Joris Mancini <[email protected]>

Author: TheMaskedTurtle

.github/config/.licenserc.yaml

@@ -0,0 +1,27 @@
+header:
+  license:
+    spdx-id: MPL-2.0
+    pattern: |
+      Copyright copyright \d{4}, RTE \(http:\/\/www\.rte-france\.com\)
+      This Source Code Form is subject to the terms of the Mozilla Public
+      License, v\. 2\.0\. If a copy of the MPL was not distributed with this
+      file, You can obtain one at http:\/\/mozilla\.org\/MPL\/2\.0\/\.
+
+  paths-ignore:
+    - 'dist'
+    - 'licenses'
+    - '**/*.md'
+    - 'LICENSE'
+    - 'NOTICE'
+    - 'Dockerfile'
+    - '**/.*'
+    - '**/*.txt'
+    - '**/*.json'
+    - '**/*.yaml'
+    - '**/*.yml'
+    - '**/*.svg'
+    - '**/*.css'
+    - '**/*.conf'
+    - '**/*.properties'
+
+  comment: on-failure

.github/workflows/build.yml

@@ -7,6 +7,22 @@ on:
   pull_request:
 
 jobs:
+  license-headers:
+    name: Check licenses headers
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/setup-node@v3
+      - name: Checkout sources
+        uses: actions/checkout@v2
+        with:
+          persist-credentials: false
+
+      - name: Check License Header (Check Mode)
+        uses: apache/skywalking-eyes/[email protected]
+        with:
+          config: .github/config/.licenserc.yaml
+
   build-and-deploy:
     runs-on: ubuntu-latest
 
@@ -24,6 +40,7 @@ jobs:
       - name: Install and Build
         run: |
           npm install
+          npm run licenses-check
           npm run lint
           npm run test:coverage
           npm run build

src/components/App/app.test.tsx

@@ -1,3 +1,9 @@
+/*
+ * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
 // app.test.tsx
 
 import React, { FunctionComponent, PropsWithChildren } from 'react';

src/module-emotion.d.ts

@@ -1,3 +1,9 @@
+/*
+ * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
 // https://github.com/emotion-js/emotion/discussions/2291
 //   https://emotion.sh/docs/typescript#define-a-theme
 

src/module-mui.d.ts

@@ -1,3 +1,9 @@
+/*
+ * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
 // https://mui.com/material-ui/customization/theming/#typescript
 import { CSSObject } from '@mui/styled-engine';
 import { Theme as MuiTheme, ThemeOptions as MuiThemeOptions } from '@mui/material/styles/createTheme';
@@ -15,7 +21,9 @@ declare module '@mui/material/styles/createTheme' {
         agGridTheme: 'ag-theme-alpine' | 'ag-theme-alpine-dark';
         agGridThemeOverride?: CSSObject;
     };
+
     export interface Theme extends MuiTheme, ThemeExtension {}
+
     // allow configuration using `createTheme`
     export interface ThemeOptions extends MuiThemeOptions, Partial<ThemeExtension> {}
 }

src/services/index.ts

@@ -1,3 +1,10 @@
+/*
+ * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
 export * as ConfigSrv from './config';
 export type * from './config';
 

src/translations/ag-grid/locales.ts

@@ -1,3 +1,9 @@
+/*
+ * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
 // from https://github.com/ag-grid/ag-grid/blob/latest/documentation/ag-grid-docs/src/content/docs/localisation/_examples/localisation/locale.en.js
 /* eslint-disable no-template-curly-in-string */