Skip to content
This repository was archived by the owner on Jun 18, 2025. It is now read-only.

MATLAB template for GitHub Actions#1

Merged
mw-kapilg merged 6 commits intomainfrom
kapilg/base-template
Mar 10, 2023
Merged

MATLAB template for GitHub Actions#1
mw-kapilg merged 6 commits intomainfrom
kapilg/base-template

Conversation

@mw-kapilg
Copy link
Copy Markdown
Collaborator

KG: This is a new internal pull request (after moving repo to matlab-actions) for our review.
Although the CONTRIBUTING page mentions "only accepting new starter workflows for Code Scanning", it might be outdated as I see new submissions in the ci directory too like this one.
Below is the template for pull request provided by GitHub Actions


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.

Comment thread ci/matlab.yml Outdated
Comment thread ci/matlab.yml Outdated
Comment thread ci/matlab.yml Outdated
Comment thread ci/matlab.yml Outdated
Comment thread ci/matlab.yml Outdated
Comment thread ci/matlab.yml Outdated
Comment thread ci/matlab.yml Outdated
Copy link
Copy Markdown
Member

@mw-hrastega mw-hrastega left a comment

Choose a reason for hiding this comment

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

Some additional comments.

@mw-kapilg mw-kapilg requested a review from mw-hrastega March 2, 2023 04:34
Comment thread ci/matlab.yml
Comment thread ci/matlab.yml Outdated
Comment thread ci/matlab.yml Outdated
Comment thread ci/matlab.yml Outdated
Comment thread ci/matlab.yml Outdated
@mw-kapilg mw-kapilg requested a review from mw-hrastega March 6, 2023 04:17
Comment thread ci/matlab.yml Outdated
Comment thread ci/matlab.yml Outdated
Copy link
Copy Markdown
Member

@mw-hrastega mw-hrastega 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 the changes. Once the pull request gets approved, let's send it for a quick review by our editor.

Comment thread ci/matlab.yml
Comment thread ci/matlab.yml Outdated
Comment thread ci/matlab.yml Outdated
Comment thread ci/matlab.yml Outdated
Comment thread ci/matlab.yml Outdated
Comment thread ci/matlab.yml Outdated
Comment thread ci/properties/matlab.properties.json Outdated
Comment thread ci/properties/matlab.properties.json
Comment thread ci/properties/matlab.properties.json
Comment thread ci/properties/matlab.properties.json
@mw-kapilg mw-kapilg requested review from mcafaro and mw-hrastega March 7, 2023 12:24
Copy link
Copy Markdown
Member

@mcafaro mcafaro left a comment

Choose a reason for hiding this comment

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

:shipit:

Comment thread ci/matlab.yml Outdated
@mw-kapilg mw-kapilg merged commit d2d425c into main Mar 10, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants