Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve package manager plugin docs #1465

Merged
merged 3 commits into from
Aug 13, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/pages/docs/_sidebar.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ Package Manager Plugins

- [Homebrew](./generated/brew)
- [Chrome Web Store](./generated/chrome)
- [Crates](./generated/crates)
- [Cocoapod](./generated/cocoapods)
- [Crates](./generated/crates)
- [Gem](./generated/gem)
- [Git Tag](./generated/git-tag)
- [Gradle](./generated/gradle)
Expand Down
3 changes: 3 additions & 0 deletions docs/pages/docs/configuration/plugins.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ If you don't configure plugins in your `.autorc` configuration file `auto` will
- Installed through `npm` => uses [`npm`](../generated/npm)
- Installed through executable => uses [`git-tag`](../generated/git-tag)

For the majority of "package manager" plugins you should only use one at a time.
Using multiple _will_ lead to undesired results.

### No Plugins

If you don't want to include the default plugins, you can supply an empty array in the `.autorc` configuration file like the following:
Expand Down
3 changes: 3 additions & 0 deletions plugins/chrome/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ npm i --save-dev @auto-it/chrome
yarn add -D @auto-it/chrome
```

> WARNING: You can only use one "package manager" at a time!
> Mixing them will lead to undesired results.

## Usage

You must first pack/zip your plugin before running `auto`.
Expand Down
3 changes: 3 additions & 0 deletions plugins/cocoapods/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ npm i --save-dev @auto-it/cocoapods
yarn add -D @auto-it/cocoapods
```

> WARNING: You can only use one "package manager" at a time!
> Mixing them will lead to undesired results.

## Usage

```json
Expand Down
3 changes: 3 additions & 0 deletions plugins/crates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ npm i --save-dev @auto-it/crates
yarn add -D @auto-it/crates
```

> WARNING: You can only use one "package manager" at a time!
> Mixing them will lead to undesired results.

## Usage

```json
Expand Down
3 changes: 3 additions & 0 deletions plugins/gem/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ npm i --save-dev @auto-it/gem
yarn add -D @auto-it/gem
```

> WARNING: You can only use one "package manager" at a time!
> Mixing them will lead to undesired results.

## Usage

```json
Expand Down
11 changes: 10 additions & 1 deletion plugins/git-tag/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Git Tag Plugin

Manage your projects version through just a git tag. This plugin is loaded by default when `auto` is installed through the binaries released on GitHub.
Manage your projects version through just a git tag.
This plugin is loaded by default when `auto` is installed through the binaries released on GitHub.

If you're using this plugin you aren't releasing your code to any platform (npm, maven, etc). Instead you version calculations is done entirely though git tags.

Expand All @@ -11,6 +12,11 @@ This plugin only:
3. create new tags
4. push to github

It will not:

1. Publish to a specific platform
2. Use any platform specific project information (ex: `author` or `repo` from a `package.json`)

## Installation

This plugin is not included with the `auto` CLI installed via NPM. To install:
Expand All @@ -21,6 +27,9 @@ npm i --save-dev @auto-it/git-tag
yarn add -D @auto-it/git-tag
```

> WARNING: You can only use one "package manager" at a time!
> Mixing them will lead to undesired results.

## Usage

Simply add the plugins to your auto configuration.
Expand Down
3 changes: 3 additions & 0 deletions plugins/gradle/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ npm i --save-dev @auto-it/gradle
yarn add -D @auto-it/gradle
```

> WARNING: You can only use one "package manager" at a time!
> Mixing them will lead to undesired results.

## Usage

```json
Expand Down
5 changes: 4 additions & 1 deletion plugins/maven/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,15 @@ Release a Java project to a [maven][maven] repository.

This plugin is not included with the `auto` CLI installed via NPM. To install:

```bashell script
```bash
npm i --save-dev @auto-it/maven
# or
yarn add -D @auto-it/maven
```

> WARNING: You can only use one "package manager" at a time!
> Mixing them will lead to undesired results.

## Usage

This plugin makes recursive changes to all `pom.xml` files in the project, with the following assumptions:
Expand Down
10 changes: 9 additions & 1 deletion plugins/npm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ npm i --save-dev @auto-it/npm
yarn add -D @auto-it/npm
```

> WARNING: You can only use one "package manager" at a time!
> Mixing them will lead to undesired results.

## Usage

```json
Expand All @@ -40,7 +43,12 @@ yarn add -D @auto-it/npm

## Monorepo Usage

The `npm` plugin works out of the box with `lerna` in both [`independent`](https://github.com/lerna/lerna#independent-mode) and [`fixed`](https://github.com/lerna/lerna#fixedlocked-mode-default) mode. `auto` works on a repo basis and should be run from the root of the repo, not on each sub-package. No additional setup is required.
The `npm` plugin works out of the box with `lerna` in both [`independent`](https://github.com/lerna/lerna#independent-mode) and [`fixed`](https://github.com/lerna/lerna#fixedlocked-mode-default) mode.
`auto` works on a repo basis and should be run from the root of the repo, not on each sub-package.
No additional setup is required.

> Do you have a package in your monorepo you don't want to publish but still want versioned?
> Just set that `"private": true` you that package's `package.json`!

## Options

Expand Down