npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

github-actions-utils

v1.0.9

Published

Utils for JS/TS github action

Downloads

9

Readme

Build status

Introduction

Common utils JS/TS Github Action

Installation

npm install github-actions-utils

Usage

Handling inputs

Extract available inputs to the object and check theirs types:

import { actionInputs, transformIfSet } from 'github-actions-utils';

const myActionInputs = {
    // required
    input1: actionInputs.getString('input1', true),
    secretInput2: actionInputs.getString('secretInput2',
        true, // required 
        true  // set value as secret
    ),
    // cast to int (or throw), optional
    intInput: actionInputs.getInt('intInput'),
    // cast to number (or throw), optional,
    floatInput: actionInputs.getFloat('floatInput'),
    // return absolute path from relative to GITHUB_WORKSPACE, required
    pathInput: actionInputs.getWsPath('pathInput', true),
    // read string input (optional) and transform it to array (split by | sign)
    arrayInput: transformIfSet(actionInputs.getString('arrayInput', false), s => s.split('|')),
};

Handling outputs

Extract available outputs to the object:

import { ActionOutput, ActionTrOutput } from 'github-actions-utils';

const myActionOutputs = {
    output1Name: new ActionOutput('output1Name'),
    // accepts array, joins it to string using | glue
    arrayOutput2Name: new ActionTrOutput('arrayOutput2Name', v => v.join('|')),
    // accepts boolean value, converts to 'true' or 'false' string
    boolOutputName: new ActionTrOutput<boolean>('boolOutputName', b => b ? 'true' : 'false'),
};

// Calls setOutput(...) inside
myActionOutputs.output1Name.setValue('output1value');
myActionOutputs.arrayOutput2Name.setValue(['el1', 'el2']);
myActionOutputs.boolOutputName.setValue(true);

myActionOutputs.arrayOutput2Name.getValue(); // -> ['el1', 'el2']
myActionOutputs.arrayOutput2Name.getStringValue(); // -> 'el1|el2'

extensionName: new ActionOutput('extensionName'),

Check ncc package is built

If you use ncc command to pack your action code (as github example suggests), you may want to ensure that you didn't forget to run ncc command and commit packed js file.

Add script to your package.json:

...
"scripts": {
    "build": "tsc",
    "pack": "ncc build",
    "all": "npm run build && npm run pack",
    "checkPackCommited": "checkIsUnchanged ./dist/index.js"   <---- this one
  }
...

Add script call in a build-test workflow after pack:

- name: Check pack is up-to-date
  run: npm run checkPackCommited

This command will check that after build performed in workflow ./dist/index.js file remains unchanged.