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

adding credo workflow #1927

Merged
merged 9 commits into from
Jun 12, 2023
Merged

Conversation

ElizabethBarrord
Copy link
Contributor

@ElizabethBarrord ElizabethBarrord commented Feb 2, 2023

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.

@github-actions github-actions bot added the code-scanning Related to workflows that show on the Code Scanning setup page label Feb 2, 2023
@ElizabethBarrord
Copy link
Contributor Author

thank you for the review, @AlexDeMichieli ! And I added the credo properties here, thank you for that!

@ElizabethBarrord ElizabethBarrord marked this pull request as ready for review February 22, 2023 15:46
@ElizabethBarrord ElizabethBarrord requested review from a team as code owners February 22, 2023 15:46
@github-actions github-actions bot requested a review from anuragc617 February 22, 2023 15:46
code-scanning/credo.yml Outdated Show resolved Hide resolved
code-scanning/credo.yml Outdated Show resolved Hide resolved
Copy link

@maddraddness maddraddness left a comment

Choose a reason for hiding this comment

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

Thanks for helping me

Copy link

@maddraddness maddraddness left a comment

Choose a reason for hiding this comment

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

Am I doing this right

@griffinashe
Copy link

Up until now our blocker on progress for this has been that we've need the maintainer of the Credo project to sign up for our Tech Partner Program. That's now complete. Can this be merged?

Copy link
Contributor

@jtamsut jtamsut left a comment

Choose a reason for hiding this comment

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

This looks reasonable. If I icon is added this should be ready to go.

@jtamsut jtamsut self-requested a review June 7, 2023 22:05
@ElizabethBarrord ElizabethBarrord requested a review from a team as a code owner June 7, 2023 22:12
@jtamsut jtamsut self-requested a review June 7, 2023 22:15
@ElizabethBarrord
Copy link
Contributor Author

@jtamsut

This looks reasonable. If I icon is added this should be ready to go.

added icon "code" 16PX from https://primer.style/design/foundations/icons 👍🏻

Copy link
Contributor

@jtamsut jtamsut left a comment

Choose a reason for hiding this comment

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

This looks reasonable to me

@ElizabethBarrord
Copy link
Contributor Author

hi @jtamsut thank you for your approval, do you happen to know why the "validate-data" workflow has not kicked off?

@jtamsut jtamsut merged commit d307831 into actions:main Jun 12, 2023
@965022-oss
Copy link

Merged #2668
Branch: main
965022-oss-patch3
SHA: f4dbb8424c
Branch: main
965022-oss-patch1
SHA: 3a95482282

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.

7 participants