Add some information about the project context

camptocamp · Dec 8, 2020 · 6195e1d · 6195e1d
1 parent da2384d
commit 6195e1d
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -29,6 +29,20 @@ At the base of the configuration you have:
 
 Many actions can be disabled by setting the corresponding configuration part to `False`.
 
+# Checks
+
+The curent configuration profile consider we use a project with:
+
+-   The following workflows:
+    -   `Continus interation`,
+    -   `Rebuild` on all supported branch,
+    -   `Audit` for security issune on all supported branches,
+    -   `Backport` between all supported branches,
+    -   `Clean Docker hub tags`,
+    -   `Auto merge Dependabot updates`.
+-   A `SECURITY.md` file.
+-   And we also check that the code is conform with the `black` and `isort` rules, for the coformity with
+    the `gitattributes`, and for the right end of file on text files.
 
 # Publishing
 

diff --git a/example-project/.github/workflows/clean.yaml b/example-project/.github/workflows/clean.yaml
@@ -1,12 +1,12 @@
 ---
-name: Clean docker hub tags
+name: Clean Docker hub tags
 
 on: delete
 
 jobs:
   clean:
     runs-on: ubuntu-20.04
-    name: Clean docker hub tags
+    name: Clean Docker hub tags
     timeout-minutes: 5
 
     steps: