updater-appveyor
Version:
Update appveyor.yml based on preferences.
137 lines (86 loc) • 6.71 kB
Markdown
<p align="center">
<a href="https://github.com/update/update">
<img height="150" width="150" src="https://raw.githubusercontent.com/update/update/master/docs/logo.png">
</a>
</p>
Update appveyor.yml based on preferences.
# updater-appveyor
[](https://www.npmjs.com/package/updater-appveyor) [](https://npmjs.org/package/updater-appveyor) [](https://travis-ci.org/update/updater-appveyor)
## Table of Contents
- [What is "Update"?](#what-is-update)
- [What does updater-appveyor do?](#what-does-updater-appveyor-do)
- [Getting started](#getting-started)
* [Install](#install)
* [Usage](#usage)
* [Tasks](#tasks)
- [About](#about)
* [Related projects](#related-projects)
* [Community](#community)
* [Contributing](#contributing)
* [Running tests](#running-tests)
* [Author](#author)
* [License](#license)
_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_
## What is "Update"?
[Update](https://github.com/update/update) is a new, open-source developer framework for automating updates of any kind to code projects. All actual updating is done plugins called "updaters", like this one.
Updaters can be run from the command line when [Update's CLI](https://github.com/update/update/blob/master/docs/installing-the-cli.md) is installed globally, or they can be used as building blocks for creating other [updaters](https://github.com/update/update/blob/master/docs/updaters.md).
**For more information:**
* Visit the [update project](https://github.com/update/update)
* Visit the [update documentation](https://github.com/update/update/blob/master/docs/)
* Find [updaters on npm](https://www.npmjs.com/browse/keyword/update-updater) (help us [author updaters](https://github.com/update/update/blob/master/docs/updaters.md))
## What does updater-appveyor do?
Most updaters do one specific thing. This updater adds an `appveyor.yml` file or replaces the `appveyor.yml` file in the current working directory using a template defined by you in `~/templates/appveyor.yml` (user home on your system), or the generic template in this project's [templates](templates) directory.
## Getting started
### Install
**Installing the CLI**
To run `updater-appveyor` from the command line, you'll need to install [Update](https://github.com/update/update) globally first. You can do that now with the following command:
```sh
$ npm install --global update
```
This adds the `update` command to your system path, allowing it to be run from any directory.
**Install updater-appveyor**
Install this module with the following command:
```sh
$ npm install --global updater-appveyor
```
### Usage
Make sure your work is committed, then run the updater's `default` [task](https://github.com/update/update/blob/master/docs/tasks.md#default-task) with the following command:
```sh
$ update appveyor
```
**What will happen?**
Upon running `$ update appveyor` command, this updater's `default` task will be executed, which replaces the `appveyor.yml` file in the cwd with the `~/templates/appveyor.yml` template defined by you, or the default templates found in [templates/appveyor.yml](templates/appveyor.yml) in this repository.
### Tasks
Visit the [documentation for tasks](https://github.com/update/update/blob/master/docs/tasks.md).
## About
### Related projects
* [updater-editorconfig](https://www.npmjs.com/package/updater-editorconfig): Update or add a `.editorconfig` in the current working directory using a template defined by… [more](https://github.com/update/updater-editorconfig) | [homepage](https://github.com/update/updater-editorconfig "Update or add a `.editorconfig` in the current working directory using a template defined by you in `~/templates`, or generic one if a custom template is not defined. This is an Update `updater`, which can be run from the command line when Update is insta")
* [updater-eslint](https://www.npmjs.com/package/updater-eslint): Update a `.eslintrc.json` file based on a template and preferences. This updater can be used… [more](https://github.com/update/updater-eslint) | [homepage](https://github.com/update/updater-eslint "Update a `.eslintrc.json` file based on a template and preferences. This updater can be used from the command line when installed globally, or as a plugin in other updaters.")
* [updater-license](https://www.npmjs.com/package/updater-license): Update the copyright statement and year in a MIT `LICENSE` file. | [homepage](https://github.com/update/updater-license "Update the copyright statement and year in a MIT `LICENSE` file.")
* [updater-travis](https://www.npmjs.com/package/updater-travis): Update .travis.yml based on preferences. | [homepage](https://github.com/update/updater-travis "Update .travis.yml based on preferences.")
### Community
Are you using [Update](https://github.com/update/update) in your project? Have you published an [updater](https://github.com/update/update/blob/master/docs/updaters.md) and want to share your Update project with the world?
Here are some suggestions!
* If you get like Update and want to tweet about it, please use the hashtag `#updatejs` (not `@`)
* Show your love by starring [Update](https://github.com/update/update) and `updater-appveyor`
* Get implementation help on [StackOverflow](http://stackoverflow.com/questions/tagged/update) (please use the `updatejs` tag in questions)
* **Gitter** Discuss Update with us on [Gitter](https://gitter.im/update/update)
* If you publish an updater, thank you! To make your project as discoverable as possible, please add the keyword `updateupdater` to package.json.
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Please read the [contributing guide](contributing.md) for avice on opening issues, pull requests, and coding standards.
### Running tests
Install dev dependencies:
```sh
$ npm install -d && npm test
```
### Author
**Brian Woodward**
* [github/doowb](https://github.com/doowb)
* [twitter/doowb](http://twitter.com/doowb)
### License
Copyright © 2016, [Brian Woodward](https://github.com/doowb).
Released under the [MIT license](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.0, on December 15, 2016._