Giter Club home page Giter Club logo

validate-nerdpack-action's Introduction

Community Project header

Validate Nerdpack Action

GitHub Marketplace version

A GitHub Action to check for the presence of our standard open source files, catalog files (if applicable), and package script commands.

Inputs

Key Required Default Description
files no - Comma-separated list of files to validate existence for. These are appended to default list of files, unless override flag is set to true.
path no - Sets the directory the Action will run from.
override no false By default, the files option will append to the default list of files being checked. This flag allows overwriting the whole list.

Example Usage

Basic validation

The following example shows how to use the valiate-nerdpace-action to ensure all Nerdpack standards are adhered to in a Pull Request.

name: "Build and Validate Nerdpack"

on:
  pull_request:
      branches:
        - main

jobs:
  validate-nerdpack:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Repo
        uses: actions/checkout@v2
      - name: "Validate Nerdpack"
        uses: newrelic/validate-nerdpack-action@v1
        with:
          files: "package.json, LICENSE, README.md, foo, bar"
      
      # Now run nr1 nerdpack:validate to ensure nerdpack is able to be published
      - name: Install NR1 CLI
        run: |
          curl -s https://cli.nr-ext.net/installer.sh | sudo bash
      - name: Validate Nerdpack Schema
        run: |
          nr1 nerdpack:validate

Custom Input Options

Add files, path, and override configuration.

name: "Build and Validate Nerdpack"

on: 
  pull_request:
      branches:
        - main

jobs:
  validate-nerdpack:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Repo
        uses: actions/checkout@v2
      - name: "Validate Nerdpack"
        uses: newrelic/validate-nerdpack-action@v1
        with:
          files: "package.json, LICENSE, README.md, foo, bar"
          override: true
          path: ./apps/nr1-browser-analyzer # set Action to run from base Nerdpack directory
      
      # Now run nr1 nerdpack:validate to ensure nerdpack is able to be published
      - name: Install NR1 CLI
        run: |
          curl -s https://cli.nr-ext.net/installer.sh | sudo bash
      - name: Validate Nerdpack Schema
        run: |
          nr1 nerdpack:validate

License

Validate Nerdpack Action is licensed under the Apache 2.0 License.

This repo also uses source code from third party libraries. Full details on which libraries are used and the terms under which they are licensed can be found in the third party notices document.

validate-nerdpack-action's People

Contributors

jbeveland27 avatar semantic-release-bot avatar nr-opensource-bot avatar tangollama avatar dependabot[bot] 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.