-
-
Notifications
You must be signed in to change notification settings - Fork 111
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create generator-generic-ossf-slsa3-publish.yml
Signed-off-by: admin-xspace <[email protected]>
- Loading branch information
admin-xspace
authored
Nov 5, 2024
1 parent
6838c70
commit 838beed
Showing
1 changed file
with
109 additions
and
0 deletions.
There are no files selected for viewing
109 changes: 109 additions & 0 deletions
109
.github/workflows/generator-generic-ossf-slsa3-publish.yml
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 |
---|---|---|
@@ -0,0 +1,109 @@ | ||
/** | ||
* @import {Root as HastRoot} from 'hast' | ||
* @import {Root as MdastRoot} from 'mdast' | ||
* @import {Plugin} from 'unified' | ||
*/ | ||
|
||
/** | ||
* @typedef Options | ||
* Configuration (optional). | ||
* @property {boolean | null | undefined} [someField] | ||
* Some option (optional). | ||
*/ | ||
|
||
// To type options: | ||
/** @type {Plugin<[(Options | null | undefined)?]>} */ | ||
export function myPluginAcceptingOptions(options) { | ||
const settings = options || {} | ||
// `settings` is now `Options`. | ||
} | ||
|
||
// To type a plugin that works on a certain tree, without options: | ||
/** @type {Plugin<[], MdastRoot>} */ | ||
export function myRemarkPlugin() { | ||
return function (tree, file) { | ||
// `tree` is `MdastRoot`. | ||
} | ||
} | ||
|
||
// To type a plugin that transforms one tree into another: | ||
/** @type {Plugin<[], MdastRoot, HastRoot>} */ | ||
export function remarkRehype() { | ||
return function (tree) { | ||
// `tree` is `MdastRoot`. | ||
// Result must be `HastRoot`. | ||
} | ||
} | ||
|
||
// To type a plugin that defines a parser: | ||
/** @type {Plugin<[], string, MdastRoot>} */ | ||
export function remarkParse(options) {} | ||
|
||
// To type a plugin that defines a compiler: | ||
/** @type {Plugin<[], HastRoot, string>} */ | ||
export function rehypeStringify(options) {}# This workflow uses actions that are not certified by GitHub. | ||
# They are provided by a third-party and are governed by | ||
# separate terms of service, privacy policy, and support | ||
# documentation. | ||
|
||
# This workflow lets you generate SLSA provenance file for your project. | ||
# The generation satisfies level 3 for the provenance requirements - see https://slsa.dev/spec/v0.1/requirements | ||
# The project is an initiative of the OpenSSF (openssf.org) and is developed at | ||
# https://github.com/slsa-framework/slsa-github-generator. | ||
# The provenance file can be verified using https://github.com/slsa-framework/slsa-verifier. | ||
# For more information about SLSA and how it improves the supply-chain, visit slsa.dev. | ||
|
||
name: SLSA generic generator | ||
on: | ||
workflow_dispatch: | ||
release: | ||
types: [created] | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
outputs: | ||
digests: ${{ steps.hash.outputs.digests }} | ||
|
||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
# ======================================================== | ||
# | ||
# Step 1: Build your artifacts. | ||
# | ||
# ======================================================== | ||
- name: Build artifacts | ||
run: | | ||
# These are some amazing artifacts. | ||
echo "artifact1" > artifact1 | ||
echo "artifact2" > artifact2 | ||
# ======================================================== | ||
# | ||
# Step 2: Add a step to generate the provenance subjects | ||
# as shown below. Update the sha256 sum arguments | ||
# to include all binaries that you generate | ||
# provenance for. | ||
# | ||
# ======================================================== | ||
- name: Generate subject for provenance | ||
id: hash | ||
run: | | ||
set -euo pipefail | ||
# List the artifacts the provenance will refer to. | ||
files=$(ls artifact*) | ||
# Generate the subjects (base64 encoded). | ||
echo "hashes=$(sha256sum $files | base64 -w0)" >> "${GITHUB_OUTPUT}" | ||
provenance: | ||
needs: [build] | ||
permissions: | ||
actions: read # To read the workflow path. | ||
id-token: write # To sign the provenance. | ||
contents: write # To add assets to a release. | ||
uses: slsa-framework/slsa-github-generator/.github/workflows/[email protected] | ||
with: | ||
base64-subjects: "${{ needs.build.outputs.digests }}" | ||
upload-assets: true # Optional: Upload to a new release |