generated from actions/typescript-action
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: initial testbeat publish command
- Loading branch information
1 parent
ea722bf
commit 230c1cf
Showing
18 changed files
with
16,337 additions
and
276 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
name: Test | ||
on: | ||
push: | ||
branches: | ||
- main | ||
pull_request: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
test: | ||
name: Run action | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v3 | ||
|
||
- name: Use Node.js 20.x | ||
uses: actions/setup-node@v3 | ||
|
||
- name: Install dependencies | ||
run: npm ci | ||
|
||
- name: Build | ||
run: npm run bundle | ||
|
||
- name: Run my action | ||
uses: ./ | ||
with: | ||
config: testbeats.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -100,3 +100,4 @@ __tests__/runner/* | |
# IDE files | ||
.idea | ||
*.code-workspace | ||
.testbeats.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
21.6.2 | ||
>=18.0.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,2 @@ | ||
# Repository CODEOWNERS | ||
|
||
* @actions/actions-oss-maintainers | ||
* @leelaprasadv @asaianudeep |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,37 +1,14 @@ | ||
# Create a GitHub Action Using TypeScript | ||
# TestBeats Publish Github Action | ||
|
||
[](https://github.com/super-linter/super-linter) | ||
 | ||
[](https://github.com/actions/typescript-action/actions/workflows/check-dist.yml) | ||
[](https://github.com/actions/typescript-action/actions/workflows/codeql-analysis.yml) | ||
[](./badges/coverage.svg) | ||
[](https://github.com/super-linter/super-linter) | ||
 | ||
[](https://github.com/test-results-reporter/publish/actions/workflows/check-dist.yml) | ||
[](https://github.com/test-results-reporter/publish/actions/workflows/codeql-analysis.yml) | ||
|
||
Use this template to bootstrap the creation of a TypeScript action. :rocket: | ||
Github action for testbeats publish command | ||
|
||
This template includes compilation support, tests, a validation workflow, | ||
publishing, and versioning guidance. | ||
|
||
If you are new, there's also a simpler introduction in the | ||
[Hello world JavaScript action repository](https://github.com/actions/hello-world-javascript-action). | ||
|
||
## Create Your Own Action | ||
|
||
To create your own action, you can use this repository as a template! Just | ||
follow the below instructions: | ||
|
||
1. Click the **Use this template** button at the top of the repository | ||
1. Select **Create a new repository** | ||
1. Select an owner and name for your new repository | ||
1. Click **Create repository** | ||
1. Clone your new repository | ||
|
||
> [!IMPORTANT] | ||
> | ||
> Make sure to remove or update the [`CODEOWNERS`](./CODEOWNERS) file! For | ||
> details on how to use this file, see | ||
> [About code owners](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners). | ||
## Initial Setup | ||
## Development Setup | ||
|
||
After you've cloned the repository to your local machine or codespace, you'll | ||
need to perform some initial setup steps before you can develop your action. | ||
|
@@ -74,147 +51,19 @@ need to perform some initial setup steps before you can develop your action. | |
|
||
## Update the Action Metadata | ||
|
||
The [`action.yml`](action.yml) file defines metadata about your action, such as | ||
input(s) and output(s). For details about this file, see | ||
[Metadata syntax for GitHub Actions](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions). | ||
|
||
When you copy this repository, update `action.yml` with the name, description, | ||
inputs, and outputs for your action. | ||
|
||
## Update the Action Code | ||
|
||
The [`src/`](./src/) directory is the heart of your action! This contains the | ||
source code that will be run when your action is invoked. You can replace the | ||
contents of this directory with your own code. | ||
|
||
There are a few things to keep in mind when writing your action code: | ||
|
||
- Most GitHub Actions toolkit and CI/CD operations are processed asynchronously. | ||
In `main.ts`, you will see that the action is run in an `async` function. | ||
|
||
```javascript | ||
import * as core from '@actions/core' | ||
//... | ||
|
||
async function run() { | ||
try { | ||
//... | ||
} catch (error) { | ||
core.setFailed(error.message) | ||
} | ||
} | ||
``` | ||
|
||
For more information about the GitHub Actions toolkit, see the | ||
[documentation](https://github.com/actions/toolkit/blob/master/README.md). | ||
|
||
So, what are you waiting for? Go ahead and start customizing your action! | ||
|
||
1. Create a new branch | ||
|
||
```bash | ||
git checkout -b releases/v1 | ||
``` | ||
|
||
1. Replace the contents of `src/` with your action code | ||
1. Add tests to `__tests__/` for your source code | ||
1. Format, test, and build the action | ||
|
||
```bash | ||
npm run all | ||
``` | ||
|
||
> This step is important! It will run [`ncc`](https://github.com/vercel/ncc) | ||
> to build the final JavaScript action code with all dependencies included. | ||
> If you do not run this step, your action will not work correctly when it is | ||
> used in a workflow. This step also includes the `--license` option for | ||
> `ncc`, which will create a license file for all of the production node | ||
> modules used in your project. | ||
1. (Optional) Test your action locally | ||
|
||
The [`@github/local-action`](https://github.com/github/local-action) utility | ||
can be used to test your action locally. It is a simple command-line tool | ||
that "stubs" (or simulates) the GitHub Actions Toolkit. This way, you can run | ||
your TypeScript action locally without having to commit and push your changes | ||
to a repository. | ||
|
||
The `local-action` utility can be run in the following ways: | ||
|
||
- Visual Studio Code Debugger | ||
|
||
Make sure to review and, if needed, update | ||
[`.vscode/launch.json`](./.vscode/launch.json) | ||
|
||
- Terminal/Command Prompt | ||
|
||
```bash | ||
# npx local action <action-yaml-path> <entrypoint> <dotenv-file> | ||
npx local-action . src/main.ts .env | ||
``` | ||
|
||
You can provide a `.env` file to the `local-action` CLI to set environment | ||
variables used by the GitHub Actions Toolkit. For example, setting inputs and | ||
event payload data used by your action. For more information, see the example | ||
file, [`.env.example`](./.env.example), and the | ||
[GitHub Actions Documentation](https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables). | ||
|
||
1. Commit your changes | ||
|
||
```bash | ||
git add . | ||
git commit -m "My first action is ready!" | ||
``` | ||
|
||
1. Push them to your repository | ||
|
||
```bash | ||
git push -u origin releases/v1 | ||
``` | ||
|
||
1. Create a pull request and get feedback on your action | ||
1. Merge the pull request into the `main` branch | ||
|
||
Your action is now published! :rocket: | ||
|
||
For information about versioning your action, see | ||
After testing, you can create version tag(s) that developers can use to | ||
reference different stable versions of your action. For more information, see | ||
[Versioning](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) | ||
in the GitHub Actions toolkit. | ||
|
||
## Validate the Action | ||
|
||
You can now validate the action by referencing it in a workflow file. For | ||
example, [`ci.yml`](./.github/workflows/ci.yml) demonstrates how to reference an | ||
action in the same repository. | ||
|
||
```yaml | ||
steps: | ||
- name: Checkout | ||
id: checkout | ||
uses: actions/checkout@v4 | ||
- name: Test Local Action | ||
id: test-action | ||
uses: ./ | ||
with: | ||
milliseconds: 1000 | ||
- name: Print Output | ||
id: output | ||
run: echo "${{ steps.test-action.outputs.time }}" | ||
``` | ||
|
||
For example workflow runs, check out the | ||
[Actions tab](https://github.com/actions/typescript-action/actions)! :rocket: | ||
The [`action.yml`](action.yml) file defines metadata about the action, such as | ||
input(s) and output(s). For details about this file, see | ||
[Metadata syntax for GitHub Actions](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions). | ||
|
||
## Usage | ||
|
||
After testing, you can create version tag(s) that developers can use to | ||
reference different stable versions of your action. For more information, see | ||
[Versioning](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) | ||
in the GitHub Actions toolkit. | ||
## Action Usage | ||
|
||
To include the action in a workflow in another repository, you can use the | ||
Below is an example of Testbeats action in a workflow file. To include the action in a workflow, you can use the | ||
`uses` syntax with the `@` symbol to reference a specific branch, tag, or commit | ||
hash. | ||
|
||
|
@@ -224,15 +73,18 @@ steps: | |
id: checkout | ||
uses: actions/checkout@v4 | ||
|
||
- name: Test Local Action | ||
id: test-action | ||
uses: actions/typescript-action@v1 # Commit with the `v1` tag | ||
with: | ||
milliseconds: 1000 | ||
- name: Install Dependencies | ||
id: npm-ci | ||
run: npm ci | ||
|
||
- name: Print Output | ||
id: output | ||
run: echo "${{ steps.test-action.outputs.time }}" | ||
- name: Test | ||
id: npm-ci-test | ||
run: npm run test | ||
|
||
- name: TestBeats Publish | ||
uses: test-results-reporter/[email protected] | ||
with: | ||
config: .testbests.json # TestBests configuration file path | ||
``` | ||
## Publishing a New Release | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
<?xml version="1.0" encoding="UTF-8" ?> | ||
<testsuites id="id" name="Default suite" tests="4" failures="0" errors="" time="2"> | ||
<testsuite id="codereview.cobol.analysisProvider" name="COBOL Code Review" tests="4" failures="0" time="2"> | ||
<testcase id="codereview.cobol.rules.ProgramIdRule" name="Use a program name that matches the source file name" time="2"> | ||
<failure message="PROGRAM.cbl:2 Use a program name that matches the source file name" type="WARNING"> | ||
Some Text | ||
</failure> | ||
</testcase> | ||
</testsuite> | ||
</testsuites> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,16 @@ | ||
name: 'The name of your action here' | ||
description: 'Provide a description here' | ||
author: 'Your name or organization here' | ||
name: 'TestBeats Publish Action' | ||
description: 'Publish test results to Microsoft Teams, Google Chat, Slack and other platforms' | ||
author: 'TestBeats' | ||
|
||
# Add your action's branding here. This will appear on the GitHub Marketplace. | ||
branding: | ||
icon: 'heart' | ||
color: 'red' | ||
icon: 'bar-chart-2' | ||
color: 'blue' | ||
|
||
# Define your inputs here. | ||
inputs: | ||
milliseconds: | ||
description: 'Your input description here' | ||
config: | ||
description: 'Path to Testbeats configuration file' | ||
required: true | ||
default: '1000' | ||
|
||
# Define your outputs here. | ||
outputs: | ||
time: | ||
description: 'Your output description here' | ||
|
||
runs: | ||
using: node20 | ||
main: dist/index.js | ||
using: 'node20' | ||
main: 'dist/index.js' |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.