https://github.com/kierandrewett/mozshell-action

https://github.com/kierandrewett/mozshell-action

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/kierandrewett/mozshell-action
• Owner: kierandrewett
• License: mit
• Created: 2020-12-05T18:19:34.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-01-24T08:02:53.000Z (almost 2 years ago)
• Last Synced: 2024-10-18T12:17:53.645Z (29 days ago)
• Language: TypeScript
• Size: 163 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



# Create a JavaScript Action using TypeScript

Use this template to bootstrap the creation of a TypeScript action.:rocket:

This template includes compilation support, tests, a validation workflow, publishing, and versioning guidance.  

If you are new, there's also a simpler introduction.  See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)

## Create an action from this template

Click the `Use this Template` and provide the new repo details for your action

## Code in Main

Install the dependencies  

```bash

$ npm install

```

Build the typescript and package it for distribution

```bash

$ npm run build && npm run package

```

Run the tests :heavy_check_mark:  

```bash

$ npm test

 PASS  ./index.test.js

  ✓ throws invalid number (3ms)

  ✓ wait 500 ms (504ms)

  ✓ test runs (95ms)

...

```

## Change action.yml

The action.yml contains defines the inputs and output for your action.

Update the action.yml with your name, description, inputs and outputs for your action.

See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions)

## Change the Code

Most toolkit and CI/CD operations involve async operations so 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);

  }

}

run()

```

See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages.

## Publish to a distribution branch

Actions are run from GitHub repos so we will checkin the packed dist folder. 

Then run [ncc](https://github.com/zeit/ncc) and push the results:

```bash

$ npm run package

$ git add dist

$ git commit -a -m "prod dependencies"

$ git push origin releases/v1

```

Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project.

Your action is now published! :rocket: 

See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)

## Validate

You can now validate the action by referencing `./` in a workflow in your repo (see [test.yml](.github/workflows/test.yml))

```yaml

uses: ./

with:

  milliseconds: 1000

```

See the [actions tab](https://github.com/actions/typescript-action/actions) for runs of this action! :rocket:

## Usage:

After testing you can [create a v1 tag](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) to reference the stable and latest V1 action