Skip to content

✨ Add entry for SLSA Go builder#1600

Merged
bishal-pdMSFT merged 22 commits intoactions:mainfrom
laurentsimon:feat/slsa3go
Jun 20, 2022
Merged

✨ Add entry for SLSA Go builder#1600
bishal-pdMSFT merged 22 commits intoactions:mainfrom
laurentsimon:feat/slsa3go

Conversation

@laurentsimon
Copy link
Copy Markdown
Contributor

@laurentsimon laurentsimon commented Jun 8, 2022

Pre-requisites

  • Prior to submitting a new workflow, please apply to join the GitHub Technology Partner Program: partner.github.com/apply.

Please note that at this time we are only accepting new starter workflows for Code Scanning. Updates to existing starter workflows are fine.


Tasks

For all workflows, the workflow:

  • Should be contained in a .yml file with the language or platform as its filename, in lower, kebab-cased format (for example, docker-image.yml). Special characters should be removed or replaced with words as appropriate (for example, "dotnet" instead of ".NET").
  • Should use sentence case for the names of workflows and steps (for example, "Run tests").
  • Should be named only by the name of the language or platform (for example, "Go", not "Go CI" or "Go Build").
  • Should include comments in the workflow for any parts that are not obvious or could use clarification.
  • Should specify least priviledge permissions for GITHUB_TOKEN so that the workflow runs successfully.

For CI workflows, the workflow:

  • Should be preserved under the ci directory.
  • Should include a matching ci/properties/*.properties.json file (for example, ci/properties/docker-publish.properties.json).
  • Should run on push to branches: [ $default-branch ] and pull_request to branches: [ $default-branch ].
  • Packaging workflows should run on release with types: [ created ].
  • Publishing workflows should have a filename that is the name of the language or platform, in lower case, followed by "-publish" (for example, docker-publish.yml).

For Code Scanning workflows, the workflow:

  • Should be preserved under the code-scanning directory.
  • Should include a matching code-scanning/properties/*.properties.json file (for example, code-scanning/properties/codeql.properties.json), with properties set as follows:
    • name: Name of the Code Scanning integration.
    • organization: Name of the organization producing the Code Scanning integration.
    • description: Short description of the Code Scanning integration.
    • categories: Array of languages supported by the Code Scanning integration.
    • iconName: Name of the SVG logo representing the Code Scanning integration. This SVG logo must be present in the icons directory.
  • Should run on push to branches: [ $default-branch, $protected-branches ] and pull_request to branches: [ $default-branch ]. We also recommend a schedule trigger of cron: $cron-weekly (for example, codeql.yml).

Some general notes:

  • This workflow must only use actions that are produced by GitHub, in the actions organization, or
  • This workflow must only use actions that are produced by the language or ecosystem that the workflow supports. These actions must be published to the GitHub Marketplace. We require that these actions be referenced using the full 40 character hash of the action's commit instead of a tag. Additionally, workflows must include the following comment at the top of the workflow file:
    # 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.
    
  • Automation and CI workflows should not send data to any 3rd party service except for the purposes of installing dependencies.
  • Automation and CI workflows cannot be dependent on a paid service or product.

@laurentsimon laurentsimon requested a review from a team as a code owner June 8, 2022 22:36
@laurentsimon
Copy link
Copy Markdown
Contributor Author

Note: this is the GA for https://github.blog/2022-04-07-slsa-3-compliance-with-github-actions/
/cc @josepalafox

/cc @MarkLodato @joshuagl @ianlewis @asraa

@MarkLodato: we need an icon. Which shall we use?

@laurentsimon laurentsimon marked this pull request as draft June 8, 2022 22:47
@laurentsimon laurentsimon marked this pull request as ready for review June 8, 2022 23:09
@laurentsimon
Copy link
Copy Markdown
Contributor Author

laurentsimon commented Jun 9, 2022

talked offline with @asraa. We've picked the generic SLSA logo from the website.

Ready for reivew

Comment thread ci/properties/go-publisher-ossf-slsa3.properties.json Outdated
@MarkLodato
Copy link
Copy Markdown

Don't you need a pure icon, not one with text? If so, then https://github.com/slsa-framework/slsa/blob/main/resources/assets/logo/SLSA-logo.svg would be appropriate instead.

@laurentsimon
Copy link
Copy Markdown
Contributor Author

Don't you need a pure icon, not one with text? If so, then https://github.com/slsa-framework/slsa/blob/main/resources/assets/logo/SLSA-logo.svg would be appropriate instead.

Updated the PR with this logo. Thanks

@laurentsimon
Copy link
Copy Markdown
Contributor Author

laurentsimon commented Jun 16, 2022

friendly ping. Are there any blockers to merge this PR?
We're waiting for the merge to finalize the blog post slsa-framework/slsa#398 (review)

/cc @josepalafox

Comment thread ci/properties/go-publisher-ossf-slsa3.properties.json Outdated
Comment thread ci/go-publisher-ossf-slsa3.yml
Comment thread ci/go-publisher-ossf-slsa3.yml
Comment thread ci/go-publisher-ossf-slsa3.yml
@@ -0,0 +1,22 @@
name: SLSA Go releaser
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a short summary:

  1. What does this starter workflow light up for customer?
  2. Any links for "more details", "support"

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. PTAL

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see this updated in the PR. Did you may be miss to push the change?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done, PTAL

@bishal-pdMSFT
Copy link
Copy Markdown
Contributor

I am not an expert in svg, but the icon does not look like a svg file. Please check. It also does not get rendered in the GitHub editor.

Copy link
Copy Markdown
Contributor

@bishal-pdMSFT bishal-pdMSFT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some comments

Comment thread ci/properties/go-ossf-slsa3-publish.properties.json Outdated
Comment thread ci/properties/go-ossf-slsa3-publish.properties.json Outdated
actions: read # To read workflow path.
# If you need more configuration options, such as ldflag examples,
# visit https://github.com/slsa-framework/slsa-github-generator#golang-projects.
uses: slsa-framework/slsa-github-generator/.github/workflows/builder_go_slsa3.yml@v1.0.0
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a comment for this PR but something to think about for future in case you plan to add more workflows for building other languages. Can they be encapsulated in a single workflow rather than a separate one for each language?
For example, look at codeql one which caters to multiple languages.

Copy link
Copy Markdown
Contributor Author

@laurentsimon laurentsimon Jun 18, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the tip. I was initially thinking of having different workflows for each language. Since most projects use a single "main" language, it would avoid noise. I'll think about this for future languages, thanks!

Copy link
Copy Markdown
Contributor

@bishal-pdMSFT bishal-pdMSFT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM apart from a small comment about description property.

@laurentsimon
Copy link
Copy Markdown
Contributor Author

I've addressed all the comments. Ready to merge on my side. Thank you so much for you comments and patience!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants