https://github.com/valentinfunk/scriptfodder-publish
https://github.com/valentinfunk/scriptfodder-publish
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/valentinfunk/scriptfodder-publish
- Owner: ValentinFunk
- License: mit
- Created: 2017-03-29T14:14:53.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-04-28T05:57:16.000Z (about 8 years ago)
- Last Synced: 2024-12-30T03:27:24.886Z (5 months ago)
- Language: JavaScript
- Size: 76.2 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# scriptfodder-publish
[](https://travis-ci.org/Kamshak/scriptfodder-publish)
[](https://badge.fury.io/js/scriptfodder-publish)
[](https://github.com/semantic-release/semantic-release)
Package to publish new versions of addons to ScriptFodder
## Usage
Upload zip of current folder as new version, using CHANGELOG as changelog:
``scriptfodder-publish --script-id=123 --api-key=asdfasdf --version-name=2.0.0 --changes=CHANGELOG``
Upload zip of dist folder as new version, using CHANGELOG as changelog:
``scriptfodder-publish --script-id=123 --api-key=asdfasdf --version-name=2.0.0 --changes=CHANGELOG --relative-to=dist``
**Full CLI usage**:
```
scriptfodder-publish
Uploads a new version to an existing scriptfodder script.
Usage:
scriptfodder-publish [glob]
glob is a pattern that is zipped and uploaded. Default is ** which
uploads everything in the current working directory.
Options:
-h --help Show this screen.
-v --version Show version.
--api-key= Scriptfodder API Key
--script-id= Scriptfodder Script ID
--version-name= Name of the new version
--changes-file= Path of the file containing the changelog
--relative-to Add files to zip relative to this folder.
e.g. scriptfodder-publish --relative-to=dist
will add all files in dist under / in the zip archive
```
**Environment variables**
Api Key and Script Id can be configured via environment variables as well:
- SF_APIKEY
- SF_SCRIPTID
**.gmodignore**
To prevent certain files from being included in the zip create a .gmodignore file in the folder that is zipped up.
Each line is a glob pattern (you can use wildcards).
Example:
```
package.json
**/*.dll
```
## License
The MIT License
```
Copyright (c) 2017 Valentin Funk
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.
```