@jakallergis/changelog

    1.6.5 • Public • Published

    typescript-action status

    Create a JavaScript Action using TypeScript

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

    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

    Create an action from this template

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

    Code in Main

    First, you'll need to have a reasonably modern version of node handy. This won't work with versions older than 9, for instance.

    Install the dependencies

    $ npm install

    Build the typescript and package it for distribution

    $ npm run build && npm run package

    Run the tests ✔️

    $ 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

    Change the Code

    Most toolkit and CI/CD operations involve async operations so the action is run in an async function.

    import * as core from '@actions/core';
    ...
    
    async function run() {
      try { 
          ...
      } 
      catch (error) {
        core.setFailed(error.message);
      }
    }
    
    run()

    See the toolkit documentation 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 and push the results:

    $ 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! 🚀

    See the versioning documentation

    Validate

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

    uses: ./
    with:
      milliseconds: 1000

    See the actions tab for runs of this action! 🚀

    Usage:

    After testing you can create a v1 tag to reference the stable and latest V1 action

    Install

    npm i @jakallergis/changelog

    DownloadsWeekly Downloads

    58

    Version

    1.6.5

    License

    MIT

    Unpacked Size

    1.21 MB

    Total Files

    69

    Last publish

    Collaborators

    • jakallergis