From 47177e86fd11767f76031be01bc3b3bad205d8cf Mon Sep 17 00:00:00 2001 From: Bryan MacFarlane Date: Thu, 30 May 2019 23:10:12 -0400 Subject: [PATCH] init --- LICENSE | 22 ++++++++++++++++++++++ README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ action.yml | 13 +++++++++++++ 3 files changed, 78 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 action.yml diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..a426ef25 --- /dev/null +++ b/LICENSE @@ -0,0 +1,22 @@ + +The MIT License (MIT) + +Copyright (c) 2018 GitHub, Inc. and contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 00000000..e3bf5d3f --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# @actions/setup-node + +This action sets by node environment for use in actions by: + +- optionally downloading and caching a version of node - npm by version spec and add to PATH +- registering problem matchers for error output +- configuring authentication for npm packages +- configuring proxy if the runner is configured to use a proxy (coming with private runners) + +# Usage + +See [action.yml](action.yml) + +Basic: +```yaml +actions: +- uses: actions/setup-node@latest + with: + version: 10.x +- run: npm install +- run: npm test +``` + +Matrix Testing: +```yaml +workflow: + build: + strategy: + matrix: + node: [ 10, 8 ] + name: Node ${{ matrix.node }} sample + actions: + - name: Setup node + uses: actions/setup-node@latest + with: + version: ${{ matrix.node }} + - run: npm install + - run: npm test +``` + +# License + +The scripts and documentation in this project are released under the [MIT License](LICENSE) \ No newline at end of file diff --git a/action.yml b/action.yml new file mode 100644 index 00000000..df2a745c --- /dev/null +++ b/action.yml @@ -0,0 +1,13 @@ +name: 'Setup Node.js for use with actions' +description: 'Setup a Node.js environment and add it to the PATH, additionally providing proxy support' +author: 'GitHub' +inputs: + version: + description: 'Version Spec of the version to use. Examples: 10.x, 10.15.1, >=10.15.0' + default: '10.x' + checkLatest: + description: 'Always checks online for the latest available version that satisfies the version spec. This is typically false unless you have a specific scenario to always get latest. This will cause it to incur download costs when potentially not necessary, especially with the hosted build pool.' + default: 'false' +runs: + using: 'node' + main: 'usenode.js' \ No newline at end of file