starter-workflows icon indicating copy to clipboard operation
starter-workflows copied to clipboard

Add Appknox starter workflow

Open ginilpg opened this issue 1 year ago • 6 comments

Pre-requisites

  • [x] 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:

  • [x] 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").
  • [x ] Should use sentence case for the names of workflows and steps (for example, "Run tests").
  • [x] Should be named only by the name of the language or platform (for example, "Go", not "Go CI" or "Go Build").
  • [x] Should include comments in the workflow for any parts that are not obvious or could use clarification.
  • [x] 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:

  • [x] Should be preserved under the code-scanning directory.
  • [x] Should include a matching code-scanning/properties/*.properties.json file (for example, code-scanning/properties/codeql.properties.json), with properties set as follows:
    • [x] name: Name of the Code Scanning integration.
    • [x] creator: Name of the organization/user producing the Code Scanning integration.
    • [x] description: Short description of the Code Scanning integration.
    • [x] categories: Array of languages supported by the Code Scanning integration.
    • [x] iconName: Name of the SVG logo representing the Code Scanning integration. This SVG logo must be present in the icons directory.
  • [x] 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:

  • [x] This workflow must only use actions that are produced by GitHub, in the actions organization, or
  • [x] 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.
    
  • [x] Automation and CI workflows should not send data to any 3rd party service except for the purposes of installing dependencies.
  • [x] Automation and CI workflows cannot be dependent on a paid service or product.

ginilpg avatar Jul 04 '24 10:07 ginilpg

@nickfyson Could you please assist us with the merging process? It has been pending for almost a month. Thank you

ginilpg avatar Jul 21 '24 06:07 ginilpg

@alexisabril We have addressed the review comment you provided. Could you please reverify the changes?

ginilpg avatar Jul 30 '24 11:07 ginilpg

@alexisabril Could you please assist us with the merging process here?

ginilpg avatar Aug 13 '24 09:08 ginilpg

@alexisabril let us know if there is any more changes required ?

subho007 avatar Aug 15 '24 13:08 subho007

Hi folks, taking a look at this PR it looks as if there might be a formatting issue in the yml for this action.

alexisabril avatar Aug 16 '24 14:08 alexisabril

Hi folks, taking a look at this PR it looks as if there might be a formatting issue in the yml for this action.

@alexisabril Formatting issues has been fixed. Could you please verify the changes?

ginilpg avatar Aug 23 '24 03:08 ginilpg

@alexisabril Could you assist us with the next steps here? Looks like the workflow needs your approval to run

ginilpg avatar Aug 29 '24 10:08 ginilpg

Hi @alexisabril, thank you for taking the time to review the PR. Could you please let us know when we can proceed with going live?

subho007 avatar Sep 02 '24 10:09 subho007

Hi folks, it appears this PR just needs to be updated at this point.

alexisabril avatar Sep 06 '24 21:09 alexisabril

@ginilpg can you rebase and update the branch?

subho007 avatar Sep 08 '24 08:09 subho007

Hi folks, it appears this PR just needs to be updated at this point.

@alexisabril The PR has been updated

ginilpg avatar Sep 09 '24 09:09 ginilpg

@alexisabril Thanks for merging the PR. We noticed that the 'Code Scanning' category is missing under workflows now. Can we add the 'Security' also as a category along with code scanning? Additionally, I realised we missed removing the 'preview' label from the properties.json file, so I've created a new PR to address that as well. Apologies for the back and forth iterations

ginilpg avatar Sep 11 '24 08:09 ginilpg