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

Update checkmarx.yml for don't group findings for Sarif #1541

Closed

Conversation

DhavalPatelPersistent
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 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.

@DhavalPatelPersistent DhavalPatelPersistent requested review from a team as code owners April 25, 2022 10:03
@github-actions github-actions bot added the code-scanning Related to workflows that show on the Code Scanning setup page label Apr 25, 2022
@Phantsure
Copy link
Contributor

Changes look good to me @DhavalPatelPersistent

@Phantsure
Copy link
Contributor

@DhavalPatelPersistent is it good to merge?

@DhavalPatelPersistent
Copy link
Contributor Author

@DhavalPatelPersistent is it good to merge?

We are yet to release the CxFow for this changes.
We create PR here as part of feature related in CxFlow development branch.
Can you please wait for time being we release the CxFlow ?

@Phantsure
Copy link
Contributor

Please drop a message here when needed to merge. Thanks

@Phantsure
Copy link
Contributor

@DhavalPatelPersistent Marking this as draft as not ready to merge

@Phantsure Phantsure marked this pull request as draft May 27, 2022 11:00
@satyamchaurasiapersistent
Copy link
Contributor

satyamchaurasiapersistent commented Jun 6, 2022

hi @Phantsure Greetings from satyam .
I would like to draw your attention that @DhavalPatelPersistent has left the organization.
so I have created new pull request GitHub repo Url issue #1596 kindly merge this so that these changes get reflected in main branch and after some time it will reflect in checkmarx plugin app as well.

@Phantsure
Copy link
Contributor

Closing this PR in favour of #1596

@Phantsure Phantsure closed this Jun 9, 2022
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
3 participants