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

Add Debricked starter workflow #2107

Merged
merged 8 commits into from
Aug 16, 2024

Conversation

4ernovm
Copy link
Contributor

@4ernovm 4ernovm commented Jul 6, 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 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).

@4ernovm 4ernovm requested review from a team as code owners July 6, 2023 14:39
@github-actions github-actions bot added the code-scanning Related to workflows that show on the Code Scanning setup page label Jul 6, 2023
@4ernovm
Copy link
Contributor Author

4ernovm commented Jan 4, 2024

@alexisabril I've noticed that you merged this PR #2234. Could you please advise what should be done to get this one merged as well?

Copy link
Contributor

@alexisabril alexisabril left a comment

Choose a reason for hiding this comment

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

Hi @4ernovm,

Thank you for the PR! I've added a few notes below, but I'm also looking to verify you as a TPP member. You checked the box that an application has been submitted, but I'm not seeing OpenText. Would you confirm if this application has been submitted and under which name?

code-scanning/debricked.yml Show resolved Hide resolved
code-scanning/debricked.yml Show resolved Hide resolved
@4ernovm
Copy link
Contributor Author

4ernovm commented Jan 17, 2024

Hi @4ernovm,

Thank you for the PR! I've added a few notes below, but I'm also looking to verify you as a TPP member. You checked the box that an application has been submitted, but I'm not seeing OpenText. Would you confirm if this application has been submitted and under which name?

Hello @alexisabril, thanks for the response. Our TPP membership is through Fortify/Micro Focus, which is still a legal entity under OpenText ownership. Would it be possible to somehow connect the TPP membership of Fortify/Micro Focus with OpenText? Also, if you have time, we have another workflow in this PR which needs a review as well, if you have the time: #2245. Thanks!

@alexisabril
Copy link
Contributor

@4ernovm, would you email our team at [email protected] to verify your TPP membership? I want to make sure I identify the correct company and perhaps take this conversation outside of this issue.

contents: read

jobs:
vulnerabilities-scan:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
vulnerabilities-scan:
vulnerabilities-scan:
name: Vulnerabilities scan

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- uses: actions/checkout@v3
- uses: actions/checkout@v4


name: Debricked Scan

on: [push]
Copy link
Contributor

Choose a reason for hiding this comment

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

Personal preference:

Suggested change
on: [push]
on:
push:

This makes it easier for people to make changes to the workflow w/o taking blame for lines that they aren't conceptually changing.

@4ernovm 4ernovm requested review from a team as code owners April 26, 2024 06:46
Copy link

This pull request has become stale and will be closed automatically within a period of time. Sorry about that.

@alexisabril alexisabril merged commit 83b6e98 into actions:main Aug 16, 2024
3 checks passed
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 new workflow no-pr-activity
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants