Skip to content

Commit a591a6f

Browse files
authored
initial version
1 parent 9e2c3f1 commit a591a6f

File tree

11 files changed

+6101
-6890
lines changed

11 files changed

+6101
-6890
lines changed

.node-version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
21.6.2
1+
22

CODEOWNERS

Lines changed: 0 additions & 3 deletions
This file was deleted.

README.md

Lines changed: 1 addition & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,86 +1,11 @@
1-
# Create a GitHub Action Using TypeScript
1+
# Pipelab Github Action
22

33
[![GitHub Super-Linter](https://github.com/actions/typescript-action/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter)
44
![CI](https://github.com/actions/typescript-action/actions/workflows/ci.yml/badge.svg)
55
[![Check dist/](https://github.com/actions/typescript-action/actions/workflows/check-dist.yml/badge.svg)](https://github.com/actions/typescript-action/actions/workflows/check-dist.yml)
66
[![CodeQL](https://github.com/actions/typescript-action/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/actions/typescript-action/actions/workflows/codeql-analysis.yml)
77
[![Coverage](./badges/coverage.svg)](./badges/coverage.svg)
88

9-
Use this template to bootstrap the creation of a TypeScript action. :rocket:
10-
11-
This template includes compilation support, tests, a validation workflow,
12-
publishing, and versioning guidance.
13-
14-
If you are new, there's also a simpler introduction in the
15-
[Hello world JavaScript action repository](https://github.com/actions/hello-world-javascript-action).
16-
17-
## Create Your Own Action
18-
19-
To create your own action, you can use this repository as a template! Just
20-
follow the below instructions:
21-
22-
1. Click the **Use this template** button at the top of the repository
23-
1. Select **Create a new repository**
24-
1. Select an owner and name for your new repository
25-
1. Click **Create repository**
26-
1. Clone your new repository
27-
28-
> [!IMPORTANT]
29-
>
30-
> Make sure to remove or update the [`CODEOWNERS`](./CODEOWNERS) file! For
31-
> details on how to use this file, see
32-
> [About code owners](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).
33-
34-
## Initial Setup
35-
36-
After you've cloned the repository to your local machine or codespace, you'll
37-
need to perform some initial setup steps before you can develop your action.
38-
39-
> [!NOTE]
40-
>
41-
> You'll need to have a reasonably modern version of
42-
> [Node.js](https://nodejs.org) handy (20.x or later should work!). If you are
43-
> using a version manager like [`nodenv`](https://github.com/nodenv/nodenv) or
44-
> [`fnm`](https://github.com/Schniz/fnm), this template has a `.node-version`
45-
> file at the root of the repository that can be used to automatically switch to
46-
> the correct version when you `cd` into the repository. Additionally, this
47-
> `.node-version` file is used by GitHub Actions in any `actions/setup-node`
48-
> actions.
49-
50-
1. :hammer_and_wrench: Install the dependencies
51-
52-
```bash
53-
npm install
54-
```
55-
56-
1. :building_construction: Package the TypeScript for distribution
57-
58-
```bash
59-
npm run bundle
60-
```
61-
62-
1. :white_check_mark: Run the tests
63-
64-
```bash
65-
$ npm test
66-
67-
PASS ./index.test.js
68-
✓ throws invalid number (3ms)
69-
wait 500 ms (504ms)
70-
test runs (95ms)
71-
72-
...
73-
```
74-
75-
## Update the Action Metadata
76-
77-
The [`action.yml`](action.yml) file defines metadata about your action, such as
78-
input(s) and output(s). For details about this file, see
79-
[Metadata syntax for GitHub Actions](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions).
80-
81-
When you copy this repository, update `action.yml` with the name, description,
82-
inputs, and outputs for your action.
83-
849
## Update the Action Code
8510

8611
The [`src/`](./src/) directory is the heart of your action! This contains the

action.yml

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,20 @@
1-
name: 'The name of your action here'
2-
description: 'Provide a description here'
3-
author: 'Your name or organization here'
4-
5-
# Add your action's branding here. This will appear on the GitHub Marketplace.
6-
branding:
7-
icon: 'heart'
8-
color: 'red'
9-
10-
# Define your inputs here.
1+
name: 'Pipelab'
2+
description: 'Run Pipelab projects'
113
inputs:
12-
milliseconds:
13-
description: 'Your input description here'
4+
action:
5+
description: 'What action to run' # run | validate
6+
required: true
7+
project:
8+
description: 'The path to a project file'
9+
required: true
10+
pipelab-version:
11+
description: 'The version of Pipelab to use'
1412
required: true
15-
default: '1000'
16-
17-
# Define your outputs here.
1813
outputs:
19-
time:
20-
description: 'Your output description here'
21-
14+
code:
15+
description: 'The exit code returned by the app'
16+
error:
17+
description: 'The exit error returned by the app'
2218
runs:
23-
using: node20
24-
main: dist/index.js
19+
using: 'node20'
20+
main: 'dist/index.js'

0 commit comments

Comments
 (0)