You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -29,6 +32,14 @@ Macaron is an analysis tool which focuses on the build process for an artifact a
29
32
are at a high-level, Macaron first defines these requirements as specific
30
33
concrete rules that can be checked automatically. Macaron has a customizable checker platform that makes it easy to define checks that depend on each other.
31
34
35
+
---------------
36
+
Getting started
37
+
---------------
38
+
39
+
To start with Macaron, see our :doc:`Installation </pages/installation>` and :doc:`Using </pages/using>` pages.
40
+
41
+
For all services and technologies that Macaron supports, see our :doc:`Supported Technologies </pages/supported_technologies/index>` page.
42
+
32
43
-------------------------
33
44
Current checks in Macaron
34
45
-------------------------
@@ -49,8 +60,11 @@ the requirements that are currently supported by Macaron.
49
60
- **Scripted build** - All build steps were fully defined in a “build script”.
50
61
- Identify and validate build script(s).
51
62
* - 1
52
-
- **Provenance available** - The provenance is available.
53
-
- Check for existence of SLSA provenance. If there are no SLSA provenance, the repo can still be compliant to level 1 given the build script is available.
63
+
- **Provenance available** - Provenances are available.
64
+
- Check for existence of provenances, which can be SLSA or `Witness`_ provenances. If there is no provenance, the repo can still be compliant to level 1 given the build script is available.
65
+
* - 1
66
+
- **Witness provenance** - One or more `Witness`_ provenances are discovered.
67
+
- Check for existence of `Witness`_ provenances, and whether artifact digests match those in the provenances.
54
68
* - 2
55
69
- **Build service** - All build steps are run using some build service (e.g. GitHub Actions)
56
70
- Identify and validate the CI service(s) used for the build process.
@@ -91,4 +105,5 @@ intermediate representations as abstractions. Using such abstractions, Macaron i
- Only projects built with Gradle and publishing to a JFrog Artifactory repo following `Maven layout <https://maven.apache.org/repository/layout.html>`_
0 commit comments