Skip to content

docs: add tutorials for running macaron #232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 29, 2023
Merged

docs: add tutorials for running macaron #232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1bede06
chore: rename API Reference to Developer Reference
May 19, 2023
242e75a
docs: add tutorial with placeholders for example reports
May 19, 2023
709a7f0
chore: add examples reports and minor fixes for the tutorial
May 20, 2023
fc09674
chore: update copyright headers
May 20, 2023
11976b1
chore: address PR feedbacks
May 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
410 changes: 410 additions & 0 deletions ...tatic/examples/micronaut-projects/micronaut-core/analyze_with_repo_path/dependencies.json
View file
Open in desktop

Large diffs are not rendered by default.

1,043 changes: 1,043 additions & 0 deletions ...rce/_static/examples/micronaut-projects/micronaut-core/analyze_with_repo_path/junit5.html
View file
Open in desktop

Large diffs are not rendered by default.

220 changes: 220 additions & 0 deletions ...rce/_static/examples/micronaut-projects/micronaut-core/analyze_with_repo_path/junit5.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,220 @@
{
"metadata": {
"timestamps": "2023-05-20 04:07:10"
},
"target": {
"info": {
"full_name": "junit-team/junit5",
"local_cloned_path": "git_repos/github_com/junit-team/junit5",
"remote_path": "https://github.com/junit-team/junit5",
"branch": "main",
"commit_hash": "39cf2d5928f4a23f5f627229ac9496e526e5693e",
"commit_date": "2023-05-19T17:35:14+02:00"
},
"provenances": {
"is_inferred": true,
"content": {
"github_actions": [
{
"_type": "https://in-toto.io/Statement/v0.1",
"subject": [],
"predicateType": "https://slsa.dev/provenance/v0.2",
"predicate": {
"builder": {
"id": "https://github.com/junit-team/junit5/blob/39cf2d5928f4a23f5f627229ac9496e526e5693e/./gradle/scripts/publishDocumentationSnapshotOnlyIfNecessary.sh"
},
"buildType": "Custom github_actions",
"invocation": {
"configSource": {
"uri": "https://github.com/junit-team/junit5@refs/heads/main",
"digest": {
"sha1": "39cf2d5928f4a23f5f627229ac9496e526e5693e"
},
"entryPoint": "https://github.com/junit-team/junit5/blob/39cf2d5928f4a23f5f627229ac9496e526e5693e/.github/workflows/main.yml"
},
"parameters": {},
"environment": {}
},
"buildConfig": {},
"metadata": {
"buildInvocationId": "https://github.com/junit-team/junit5/actions/runs/5025894467",
"buildStartedOn": "<TIMESTAMP>",
"buildFinishedOn": "<TIMESTAMP>",
"completeness": {
"parameters": "false",
"environment": "false",
"materials": "false"
},
"reproducible": "false"
},
"materials": [
{
"uri": "<URI>",
"digest": {}
}
]
}
}
]
}
},
"checks": {
"summary": {
"DISABLED": 0,
"FAILED": 4,
"PASSED": 4,
"SKIPPED": 0,
"UNKNOWN": 0
},
"results": [
{
"check_id": "mcn_build_as_code_1",
"check_description": "The build definition and configuration executed by the build service is verifiably derived from text file definitions stored in a version control system.",
"slsa_requirements": [
"Build as code - SLSA Level 3"
],
"justification": [
{
"The target repository uses build tool gradle to deploy": "https://github.com/junit-team/junit5/blob/39cf2d5928f4a23f5f627229ac9496e526e5693e/./gradle/scripts/publishDocumentationSnapshotOnlyIfNecessary.sh",
"The build is triggered by": "https://github.com/junit-team/junit5/blob/39cf2d5928f4a23f5f627229ac9496e526e5693e/.github/workflows/main.yml"
},
"Deploy command: ['./gradlew', 'gitPublishPush', '-Porg.gradle.java.installations.auto-download=false', '-Dscan.tag.Documentation']",
{
"The status of the build can be seen at": "https://github.com/junit-team/junit5/actions/runs/5025894467"
}
],
"result_type": "PASSED"
},
{
"check_id": "mcn_build_script_1",
"check_description": "Check if the target repo has a valid build script.",
"slsa_requirements": [
"Scripted Build - SLSA Level 1"
],
"justification": [
"Check mcn_build_script_1 is set to PASSED because mcn_build_service_1 PASSED."
],
"result_type": "PASSED"
},
{
"check_id": "mcn_build_service_1",
"check_description": "Check if the target repo has a valid build service.",
"slsa_requirements": [
"Build service - SLSA Level 2"
],
"justification": [
"Check mcn_build_service_1 is set to PASSED because mcn_build_as_code_1 PASSED."
],
"result_type": "PASSED"
},
{
"check_id": "mcn_version_control_system_1",
"check_description": "Check whether the target repo uses a version control system.",
"slsa_requirements": [
"Version controlled - SLSA Level 2"
],
"justification": [
{
"This is a Git repository": "https://github.com/junit-team/junit5"
}
],
"result_type": "PASSED"
},
{
"check_id": "mcn_provenance_available_1",
"check_description": "Check whether the target has intoto provenance.",
"slsa_requirements": [
"Provenance - Available - SLSA Level 1",
"Provenance content - Identifies build instructions - SLSA Level 1",
"Provenance content - Identifies artifacts - SLSA Level 1",
"Provenance content - Identifies builder - SLSA Level 1"
],
"justification": [
"Could not find any SLSA provenances."
],
"result_type": "FAILED"
},
{
"check_id": "mcn_provenance_expectation_1",
"check_description": "Check whether the SLSA provenance for the produced artifact conforms to the expected value.",
"slsa_requirements": [
"Provenance conforms with expectations - SLSA Level 3"
],
"justification": [
"Check mcn_provenance_expectation_1 is set to FAILED because mcn_provenance_level_three_1 FAILED."
],
"result_type": "FAILED"
},
{
"check_id": "mcn_provenance_level_three_1",
"check_description": "Check whether the target has SLSA provenance level 3.",
"slsa_requirements": [
"Provenance - Non falsifiable - SLSA Level 3",
"Provenance content - Includes all build parameters - SLSA Level 3",
"Provenance content - Identifies entry point - SLSA Level 3",
"Provenance content - Identifies source code - SLSA Level 2"
],
"justification": [
"Check mcn_provenance_level_three_1 is set to FAILED because mcn_provenance_available_1 FAILED."
],
"result_type": "FAILED"
},
{
"check_id": "mcn_trusted_builder_level_three_1",
"check_description": "Check whether the target uses a trusted SLSA level 3 builder.",
"slsa_requirements": [
"Hermetic - SLSA Level 4",
"Isolated - SLSA Level 3",
"Parameterless - SLSA Level 4",
"Ephemeral environment - SLSA Level 3"
],
"justification": [
"Could not find a trusted level 3 builder as a GitHub Actions workflow."
],
"result_type": "FAILED"
}
]
}
},
"dependencies": {
"analyzed_deps": 0,
"unique_dep_repos": 0,
"checks_summary": [
{
"check_id": "mcn_version_control_system_1",
"num_deps_pass": 0
},
{
"check_id": "mcn_build_as_code_1",
"num_deps_pass": 0
},
{
"check_id": "mcn_trusted_builder_level_three_1",
"num_deps_pass": 0
},
{
"check_id": "mcn_provenance_level_three_1",
"num_deps_pass": 0
},
{
"check_id": "mcn_build_script_1",
"num_deps_pass": 0
},
{
"check_id": "mcn_provenance_expectation_1",
"num_deps_pass": 0
},
{
"check_id": "mcn_provenance_available_1",
"num_deps_pass": 0
},
{
"check_id": "mcn_build_service_1",
"num_deps_pass": 0
}
],
"dep_status": []
},
"policies_passed": [],
"policies_failed": []
}
Loading