-
Notifications
You must be signed in to change notification settings - Fork 6.1k
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this 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
There was a problem hiding this 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
There was a problem hiding this 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] |
There was a problem hiding this comment.
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.
on: [push] | |
on: [push] | |
permissions: | |
contents: read |
Copilot uses AI. Check for mistakes.
Pre-requisites
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:
.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").GITHUB_TOKEN
so that the workflow runs successfully.For CI workflows, the workflow:
ci
directory.ci/properties/*.properties.json
file (for example,ci/properties/docker-publish.properties.json
).push
tobranches: [ $default-branch ]
andpull_request
tobranches: [ $default-branch ]
.release
withtypes: [ created ]
.docker-publish.yml
).For Code Scanning workflows, the workflow:
code-scanning
directory.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 theicons
directory.push
tobranches: [ $default-branch, $protected-branches ]
andpull_request
tobranches: [ $default-branch ]
. We also recommend aschedule
trigger ofcron: $cron-weekly
(for example,codeql.yml
).Some general notes:
actions
organization, or