8000 gh actions demo workflow added by xDMartoxD · Pull Request #2855 · actions/starter-workflows · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

gh actions demo workflow added #2855

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

xDMartoxD
Copy link
@xDMartoxD xDMartoxD commented Apr 28, 2025

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.

@Copilot Copilot AI review requested due to automatic review settings April 28, 2025 01:33
@xDMartoxD xDMartoxD requested review from a team as code owners April 28, 2025 01:33
Copy link
@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 1 out of 5 changed files in this pull request and generated no comments.

Files not reviewed (4)
  • script/sync-ghes/package-lock.json: Language not supported
  • script/sync-ghes/package.json: Language not supported
  • script/validate-data/package-lock.json: Language not supported
  • script/validate-data/package.json: Language not supported

@xDMartoxD xDMartoxD requested a review from Copilot April 28, 2025 02:21
Copy link
@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds a GitHub Actions demo workflow intended to showcase basic workflow functionalities.

  • Adds a new workflow that demonstrates running jobs on push events.
  • Provides simple steps for echoing messages, checking out code, and listing repository files.
Files not reviewed (4)
  • script/sync-ghes/package-lock.json: Language not supported
  • script/sync-ghes/package.json: Language not supported
  • script/validate-data/package-lock.json: Language not supported
  • script/validate-data/package.json: Language not supported
Comments suppressed due to low confidence (1)

.github/workflows/github-actions-demo.yml:12

  • The workflow uses a tag for the 'actions/checkout' action. To ensure deterministic builds, reference the action using its full 40 character commit hash.
-        uses: actions/checkout@v4

@xDMartoxD xDMartoxD requested a review from Copilot April 28, 2025 02:21
Copy link
@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds a demo workflow to showcase GitHub Actions usage with several informational echo statements to provide immediate feedback when triggered.

  • Introduces a new workflow file (.github/workflows/github-actions-demo.yml) that runs on push.
  • Defines a single job with multiple steps to check out the repository and display environment details.
Files not reviewed (4)
  • script/sync-ghes/package-lock.json: Language not supported
  • script/sync-ghes/package.json: Language not supported
  • script/validate-data/package-lock.json: Language not supported
  • script/validate-data/package.json: Language not supported

@@ -0,0 +1,18 @@
name: GitHub Actions Demo
run-name: ${{ github.actor }} is testing out GitHub Actions 🚀
on: [push]
Copy link
Preview
Copilot AI Apr 28, 2025

Choose a reason for hiding this comment

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

The workflow does not specify least privileged permissions for GITHUB_TOKEN, as required by our guidelines. Please add a 'permissions:' section with the minimum necessary permissions.

Suggested change
on: [push]
on: [push]
permissions:
contents: read

Copilot uses AI. Check for mistakes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
0