diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a67dca8 --- /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. diff --git a/README.md b/README.md index 162aa6d..db2223c 100644 --- a/README.md +++ b/README.md @@ -1 +1,26 @@ # upload-artifact + +This uploads artifacts from your build. + +# Usage + +See [action.yml](action.yml) + +Basic: +```yaml +actions: +- uses: actions/checkout@master + +- run: mkdir -p path/to/artifact + +- run: echo hello > path/to/artifact/world.txt + +- uses: actions/upload-artifact@master + with: + name: my-artifact + path: path/to/artifact +``` + +# License + +The scripts and documentation in this project are released under the [MIT License](LICENSE) diff --git a/action.yml b/action.yml index 6d011cc..28255db 100644 --- a/action.yml +++ b/action.yml @@ -7,5 +7,6 @@ inputs: required: true path: description: 'Directory containing files to upload' + required: true runs: plugin: 'publish'