msca-actions-toolkit/README.md

2.8 KiB

Microsoft Security DevOps GitHub Actions Toolkit

A GitHub Actions javascript library for running the Microsoft Security DevOps CLI.

Leveraged By

Build

Preqrequisities:

  • Install node.js (for npm)
  • Install gulp-cli globally:
    npm install -g gulp-cli
    
  • Install node package dependencies
    npm install
    

To build, simply run gulp in the root of the repo:

gulp

The build:

  1. Compiles the typescript in the ./src directory
  2. Outputs javascript to the ./dist directory
  3. Copies the ./package.json file to the ./dist folder

Publish

This package is hosted on this repo's package feed.

To publish a build, please see "Working with the npm registry".

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.