-
Notifications
You must be signed in to change notification settings - Fork 44
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.
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
build: Clarify buildType #875
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -9,13 +9,30 @@ infrastructure that the build was invoked on. | |||||
|
||||||
## Description | ||||||
|
||||||
A buildType is a URI expressing the toolchain, platform, or infrastructure that | ||||||
A buildType is a IRI expressing the toolchain, platform, or infrastructure that | ||||||
the build was invoked on. | ||||||
|
||||||
For example, if the build was invoked on GitHub's CI platform using GitHub | ||||||
Actions, the buildType can be expressed as `https://github.com/actions`. | ||||||
In contrast, if the build was invoked on a local machine, the buildType can be | ||||||
expressed as `file://username@host/path/to/build`. | ||||||
The buildType is used to interpret the meaning of other build parameters by | ||||||
defining the "type" of build; if the same buildType is seen in different Build | ||||||
elements, it means they are the same kind of build, but difference instances | ||||||
and possible with different configurations. | ||||||
|
||||||
If you are not using a well-known buildType, it should be namespaced to a | ||||||
domain you own to prevent conflicts with other builtType IRIs. | ||||||
|
||||||
Examples of a buildType might be: | ||||||
* A GitHub action workflow | ||||||
* A step in a GitHub actions pipeline | ||||||
* An invocation of a compiler or other tool | ||||||
* A script that orchestrates builds at a higher level | ||||||
|
||||||
Keep in mind that builds can be "nested" using the `ancestorOf` relationship | ||||||
|
||||||
If the buildType IRI is not recognized, it is still possible to inspect other | ||||||
properties of the build, but it may not be possible to derive deeper meaning | ||||||
from them | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
For more information, see the SLSA definition of buildType | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
## Metadata | ||||||
|
||||||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.