Giter VIP home page Giter VIP logo

action-annotations's Introduction

action-annotations

Annotates your git action

Setup

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)

...

Inputs

  type: 
    required: false
    description: 'The type of annotation: error, warning, or notice (default)'
    default: 'notice'
  msg: 
    required: true
    description: 'Message for annotation'

Usage

      - name: Annotate 
        uses: dkhunt27/action-annotations@v1
        with:
          type: notice
          msg: Annotate This!

Making changes and pushing releases

  • wait for pipelines to finish
  • git checkout main
  • git pull
  • git tag v0.3.0
  • SKIP_HOOKS=true git push origin v0.3.0
  • in github, edit tag and save (this will push to marketplace)

NPM Check

npx npm-check

npm run npm:check

License

MIT

action-annotations's People

Contributors

dkhunt27 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.