Skip to content
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

fix: Scorecard artifact upload and version bump #2786

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

spencerschrock
Copy link
Contributor

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 privileged 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.
    • creator: Name of the organization/user 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.

spencerschrock and others added 3 commits February 24, 2025 11:27
1. Scorecard update v2.4.1 was released, which includes months of bug
   fixes and a new `file_mode` input to address a .gitattributes bug.
2. Bumped actions/upload-artifact to the v4 branch. This was previously
   kept at  v3 as GHES doesn't support v4, but github.com no longer
   supports v3: as uploads return the following error "Create Artifact
   Container failed: The artifact name JSON file is not valid."

  Signed-off-by: Spencer Schrock <[email protected]>
Scorecard currently has experimental support for the `pull_request`
trigger, so we want to allow analysis to be run for it in the future.

Signed-off-by: Spencer Schrock <[email protected]>
@github-actions github-actions bot added the code-scanning Related to workflows that show on the Code Scanning setup page label Feb 24, 2025
@spencerschrock
Copy link
Contributor Author

spencerschrock commented Feb 24, 2025

This PR does a few things to fix issues our users are seeing from the existing default workflow:

  1. Scorecard update v2.4.1 was released, which includes months of bug
    fixes and a new file_mode input to address a .gitattributes bug. (OpenSSF Scorecard reporting broken kokkos/kokkos#7633). (Really this should have been releases as v2.5.0, but oh well.)

  2. Bumped actions/upload-artifact to the v4 branch. This was previously
    kept at v3 as GHES doesn't support v4
    , but github.com no longer
    supports v3: as uploads return the following error "Create Artifact
    Container failed: The artifact name JSON file is not valid." (Error: Create Artifact Container failed: The artifact name SARIF file is not valid. Request URL ossf/scorecard-action#1498)

  3. Limits the job to default branch. While this is specified in the triggers above, there are some edge cases for forks where the extra redundancy is nice (Default behavior for forks of this workflow is frustrating ossf/scorecard-action#1502)

@spencerschrock spencerschrock marked this pull request as ready for review February 24, 2025 18:55
@spencerschrock spencerschrock requested review from a team as code owners February 24, 2025 18:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code-scanning Related to workflows that show on the Code Scanning setup page
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants