Navigation Menu

Skip to content

Commit

Permalink
switch all auto-release to `auto
Browse files Browse the repository at this point in the history
  • Loading branch information
hipstersmoothie committed Jan 22, 2019
1 parent 12b1fa7 commit 8213bd5
Show file tree
Hide file tree
Showing 32 changed files with 93 additions and 95 deletions.
2 changes: 1 addition & 1 deletion .all-contributorsrc
@@ -1,5 +1,5 @@
{
"projectName": "auto-release",
"projectName": "auto",
"projectOwner": "intuit",
"repoType": "github",
"repoHost": "https://github.com",
Expand Down
20 changes: 10 additions & 10 deletions .circleci/config.yml
@@ -1,7 +1,7 @@
version: 2.1

defaults: &defaults
working_directory: ~/auto-release
working_directory: ~/auto
docker:
- image: circleci/node:8.14-browsers
environment:
Expand All @@ -13,12 +13,12 @@ aliases:
keys:
# Find a cache corresponding to this specific package.json checksum
# when this file is changed, this key will fail
- auto-release-{{ checksum "yarn.lock" }}-{{ checksum ".circleci/config.yml" }}
- auto-release-{{ checksum "yarn.lock" }}
- auto-{{ checksum "yarn.lock" }}-{{ checksum ".circleci/config.yml" }}
- auto-{{ checksum "yarn.lock" }}
# Find the most recent cache used from any branch
- auto-release-
- auto-
- &save-cache
key: auto-release-{{ checksum "yarn.lock" }}-{{ checksum ".circleci/config.yml" }}
key: auto-{{ checksum "yarn.lock" }}-{{ checksum ".circleci/config.yml" }}
paths:
- ~/.cache/yarn
- node_modules
Expand Down Expand Up @@ -51,14 +51,14 @@ jobs:
<<: *defaults
steps:
- attach_workspace:
at: ~/auto-release
at: ~/auto
- run: *lint

test:
<<: *defaults
steps:
- attach_workspace:
at: ~/auto-release
at: ~/auto
- run: *test
- run:
name: Send CodeCov Results
Expand All @@ -68,7 +68,7 @@ jobs:
<<: *defaults
steps:
- attach_workspace:
at: ~/auto-release
at: ~/auto
- run:
name: Build
command: yarn build
Expand All @@ -84,7 +84,7 @@ jobs:
<<: *defaults
steps:
- attach_workspace:
at: ~/auto-release
at: ~/auto
- run: mkdir ~/.ssh/ && echo -e "Host github.com\n\tStrictHostKeyChecking no\n" > ~/.ssh/config
- run:
name: Release
Expand All @@ -94,7 +94,7 @@ jobs:
<<: *defaults
steps:
- attach_workspace:
at: ~/auto-release
at: ~/auto
- run:
name: Publish Docs
command: yarn docs:publish
Expand Down
28 changes: 14 additions & 14 deletions README.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/home.md
Expand Up @@ -8,7 +8,7 @@

## Adding automated releases shouldn't be hard or require changing your workflow /.no-link .has-text-purple .has-text-centered\

`auto-release` makes automating releases for your open source project as simple as labels to pull requests. Releasing often means being confident in your releases. /.has-text-centered\
`auto` makes automating releases for your open source project as simple as labels to pull requests. Releasing often means being confident in your releases. /.has-text-centered\

||| row has-text-centered wide

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/auto-changelog.md
Expand Up @@ -26,7 +26,7 @@ Global Options
--repo string The repo to set the status on. Defaults to looking in the package definition for the platform
--owner string The owner of the GitHub repo. Defaults to reading from the package definition for the platform
--github-api string GitHub API to use
--plugins string[] Plugins to load auto-release with. (defaults to just npm)
--plugins string[] Plugins to load auto with. (defaults to just npm)

Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/auto-comment.md
Expand Up @@ -26,7 +26,7 @@ Global Options
--repo string The repo to set the status on. Defaults to looking in the package definition for the platform
--owner string The owner of the GitHub repo. Defaults to reading from the package definition for the platform
--github-api string GitHub API to use
--plugins string[] Plugins to load auto-release with. (defaults to just npm)
--plugins string[] Plugins to load auto with. (defaults to just npm)

Examples

Expand Down
4 changes: 2 additions & 2 deletions docs/pages/auto-init.md
@@ -1,6 +1,6 @@
# Initialization

`auto-release` provides some tools to quickly set up your project. If you do not want to use the interactive experience all these options can be configured via the [.autorc](./autorc.md) and most can be configure via CLI options.
`auto` provides some tools to quickly set up your project. If you do not want to use the interactive experience all these options can be configured via the [.autorc](./autorc.md) and most can be configure via CLI options.

## `auto init`

Expand Down Expand Up @@ -38,7 +38,7 @@ Global Options
--repo string The repo to set the status on. Defaults to looking in the package.json
--owner string The owner of the GitHub repo. Defaults to reading from the package.json
--github-api string GitHub API to use
--plugins string[] Plugins to load auto-release with. (defaults to just npm)
--plugins string[] Plugins to load auto with. (defaults to just npm)

Examples

Expand Down
4 changes: 2 additions & 2 deletions docs/pages/auto-label.md
Expand Up @@ -17,7 +17,7 @@ Global Options
--repo string The repo to set the status on. Defaults to looking in the package definition for the platform
--owner string The owner of the GitHub repo. Defaults to reading from the package definition for the platform
--github-api string GitHub API to use
--plugins string[] Plugins to load auto-release with. (defaults to just npm)
--plugins string[] Plugins to load auto with. (defaults to just npm)

Examples

Expand All @@ -28,4 +28,4 @@ Examples

Running `auto label` without the PR number enables it to run in master after a PR has been merged. You can use these labels to automate more things in your merge build pipeline other than the release.

`auto-release` the project uses this to only deploy the documentation when the last merged PR has a `documentation` label.
`auto` the project uses this to only deploy the documentation when the last merged PR has a `documentation` label.
2 changes: 1 addition & 1 deletion docs/pages/auto-pr-check.md
Expand Up @@ -28,7 +28,7 @@ Global Options
--repo string The repo to set the status on. Defaults to looking in the package definition for the platform
--owner string The owner of the GitHub repo. Defaults to reading from the package definition for the platform
--github-api string GitHub API to use
--plugins string[] Plugins to load auto-release with. (defaults to just npm)
--plugins string[] Plugins to load auto with. (defaults to just npm)

Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/auto-pr.md
Expand Up @@ -25,7 +25,7 @@ Global Options
--repo string The repo to set the status on. Defaults to looking in the package definition for the platform
--owner string The owner of the GitHub repo. Defaults to reading from the package definition for the platform
--github-api string GitHub API to use
--plugins string[] Plugins to load auto-release with. (defaults to just npm)
--plugins string[] Plugins to load auto with. (defaults to just npm)

Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/auto-release.md
Expand Up @@ -44,7 +44,7 @@ Global Options
--repo string The repo to set the status on. Defaults to looking in the package definition for the platform
--owner string The owner of the GitHub repo. Defaults to reading from the package definition for the platform
--github-api string GitHub API to use
--plugins string[] Plugins to load auto-release with. (defaults to just npm)
--plugins string[] Plugins to load auto with. (defaults to just npm)

Examples

Expand Down
4 changes: 2 additions & 2 deletions docs/pages/auto-shipit.md
@@ -1,6 +1,6 @@
# `auto shipit`

Run the full auto-release project. Will detect if in a lerna project and publish accordingly.
Run the full `auto` release pipeline. Will detect if in a lerna project and publish accordingly.

```sh
auto shipit
Expand All @@ -24,7 +24,7 @@ Global Options
--repo string The repo to set the status on. Defaults to looking in the package definition for the platform
--owner string The owner of the GitHub repo. Defaults to reading from the package definition for the platform
--github-api string GitHub API to use
--plugins string[] Plugins to load auto-release with. (defaults to just npm)
--plugins string[] Plugins to load auto with. (defaults to just npm)

Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/auto-version.md
Expand Up @@ -18,7 +18,7 @@ Global Options
--repo string The repo to set the status on. Defaults to looking in the package definition for the platform
--owner string The owner of the GitHub repo. Defaults to reading from the package definition for the platform
--github-api string GitHub API to use
--plugins string[] Plugins to load auto-release with. (defaults to just npm)
--plugins string[] Plugins to load auto with. (defaults to just npm)

Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/autorc.md
Expand Up @@ -124,7 +124,7 @@ To include Jira story information in your changelogs you must include a URL to y

### githubApi

If you are using enterprise github `auto-release` lets you configure the github API URL that it uses.
If you are using enterprise github, `auto` lets you configure the github API URL that it uses.

```json
{
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/circleci.md
Expand Up @@ -6,7 +6,7 @@ The following config declares the `release` job and uses it in the `build_and_re
version: 2

defaults: &defaults
working_directory: ~/auto-release-test
working_directory: ~/auto
docker:
- image: circleci/node:latest-browsers

Expand All @@ -17,7 +17,7 @@ jobs:
<<: *defaults
steps:
- attach_workspace:
at: ~/auto-release-test
at: ~/auto
- run:
name: Release
command: npm run release
Expand Down
16 changes: 8 additions & 8 deletions docs/pages/getting-started.md
@@ -1,14 +1,14 @@
# Getting Started

Before we do anything we must first install `auto-release-cli` as a dev dependency.
Before we do anything we must first install `auto` as a dev dependency.

```sh
yarn add -D auto-release-cli
yarn add -D auto
```

## Enterprise

If you are using enterprise github `auto-release` lets you configure the github API URL that it uses. You can configure this by using the CLI option `--github-api`, by setting the value in your [.autorc](./autorc.md#githubApi), or during `auto init`.
If you are using enterprise github `auto` lets you configure the github API URL that it uses. You can configure this by using the CLI option `--github-api`, by setting the value in your [.autorc](./autorc.md#githubApi), or during `auto init`.

### Project already published

Expand All @@ -23,11 +23,11 @@ git push --tags

Then on GitHub go to your project's releases and click `Draft a new release`. In the `Tag version` field enter the version number you just tagged and click `Publish release`.

Now your github project is set up to use `auto-release`.
Now your github project is set up to use `auto`.

## Configuration

Getting started with `auto-release` is super easy.
Getting started with `auto` is super easy.

1. `auto init` (optional)
2. `auto create-labels`
Expand All @@ -36,11 +36,11 @@ Getting started with `auto-release` is super easy.

### 1. Initialize Options

Initialize all options and configure label text. If this is not run then `auto-release` will use the default configuration. This command will produce and `.autorc`, this contains advanced configuration and might not be needed.
Initialize all options and configure label text. If this is not run then `auto` will use the default configuration. This command will produce and `.autorc`, this contains advanced configuration and might not be needed.

### 2. Labels

After that, you need to set up the labels on your github project. The types of labels that `auto-release` uses are:
After that, you need to set up the labels on your github project. The types of labels that `auto` uses are:

- Versioning Labels - used to calculate version numbers and make releases. To change them refer to [this](./autorc.md#versioning-labels).
- Changelog Labels - These labels do not effect the version calculation but they will change the section the PR displays in the changelog. These are customizable too, and you can even add your own sections. Read more [here](./autorc.md#changelog-titles)
Expand All @@ -67,7 +67,7 @@ NPM_TOKEN=PUBLISH_TOKEN

### 4. Script

`auto-release` is written so that each tool it exposes is useful in isolation. It also provides workflows for those who don't care about the details of each tool and just want their code released.
`auto` is written so that each tool it exposes is useful in isolation. It also provides workflows for those who don't care about the details of each tool and just want their code released.

#### Quick Setup

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/introduction.md
@@ -1,6 +1,6 @@
![Markdown](../images/auto.gif)/.header-image\

# :rocket: auto-release :rocket:/.has-text-centered\
# :rocket: auto :rocket:/.has-text-centered\

CI/CD helpers for github releases. Generate releases based on semantic version labels on pull requests.

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/pr-interaction.md
@@ -1,6 +1,6 @@
# Pull Request Interaction

`auto-release` also includes a variety of PR interaction tools to update PRs from the CI. You can use these tools in various ways to make your PR validation process much more customized.
`auto` also includes a variety of PR interaction tools to update PRs from the CI. You can use these tools in various ways to make your PR validation process much more customized.

<br />

Expand Down
4 changes: 2 additions & 2 deletions docs/pages/publishing.md
@@ -1,6 +1,6 @@
# Publishing

`auto-release`'s main use it to automate the release process for your project This can be broken down into three core steps:
`auto`'s main use it to automate the release process for your project This can be broken down into three core steps:

```text
pre: (optional) Check if new version
Expand All @@ -10,4 +10,4 @@ pre: (optional) Check if new version
3. Generate github release notes
```

`auto-release` makes no assumptions about your publishing process. Each tool is a function that can be run in isolation and only does one thing really well. For instance, you could just use `auto changelog` to generate the changelog and nothing else or use `auto version` to calculate just the semver bump.
`auto` makes no assumptions about your publishing process. Each tool is a function that can be run in isolation and only does one thing really well. For instance, you could just use `auto changelog` to generate the changelog and nothing else or use `auto version` to calculate just the semver bump.
16 changes: 8 additions & 8 deletions docs/pages/troubleshooting.md
Expand Up @@ -2,11 +2,11 @@

## Error: Can't find a GitHub token to use

You must set a `GH_TOKEN` for `auto-release` to work. Make sure to add your `NPM_TOKEN` while you're at it.
You must set a `GH_TOKEN` for `auto` to work. Make sure to add your `NPM_TOKEN` while you're at it.

## npm ERR! Git working directory not clean

To version and publish you cannot have any changes in the git repo during publish. This means that if you build some files before release that aren't gitignored `auto` will fail to continue. To fix this either add those `dist` files to your `.gitignore` or commit them somehow before the relese.
To version and publish you cannot have any changes in the git repo during publish. This means that if you build some files before release that aren't git-ignored `auto` will fail to continue. To fix this either add those `dist` files to your `.gitignore` or commit them somehow before the release.

## npm ERR! need auth auth required for publishing

Expand Down Expand Up @@ -52,18 +52,18 @@ This means that you do not have a repository set in your package.json. Add somet
{
"repository": {
"type": "git",
"url": "https://github.com/intuit/auto-release"
"url": "https://github.com/intuit/auto"
},
// or simply
"repository": "intuit/auto-release"
"repository": "intuit/auto"
}
```

## How do I auto-release a fork of another repo?
## How do I auto a fork of another repo?

If auto-release doesn't find a last release it will default to the first commit for version calculation (and a log of other things). If you have forked a repo, you fork all the merge commit messages as well. This confuses `auto-release` since it will look for those pull requests in your fork and not the main one.
If auto doesn't find a last release it will default to the first commit for version calculation (and a log of other things). If you have forked a repo, you fork all the merge commit messages as well. This confuses `auto` since it will look for those pull requests in your fork and not the main one.

To remedy this first tag your first commit in the fork with your first version. If the tags from the original repo are still in your repo you should just bump that version. This will let `auto-release` ignore all the old merge commits.
To remedy this first tag your first commit in the fork with your first version. If the tags from the original repo are still in your repo you should just bump that version. This will let `auto` ignore all the old merge commits.

::: message is-warning
:warning: You must also match this new tag version in your package.json
Expand All @@ -74,4 +74,4 @@ To remedy this first tag your first commit in the fork with your first version.
git tag v2.10.1
```

Then on GitHub go to your project, click release, then draft a new release. Select the tag you just published and `publish release`. Now auto-release will be able to use the correct version and git log!
Then on GitHub go to your project, click release, then draft a new release. Select the tag you just published and `publish release`. Now auto will be able to use the correct version and git log!
4 changes: 2 additions & 2 deletions docs/pages/writing-plugins.md
Expand Up @@ -8,7 +8,7 @@ A plugin definition is:
- a constructor where you can load plugin specific config

```ts
import { AutoRelease, IPlugin } from 'auto-release-cli';
import { AutoRelease, IPlugin } from 'auto';

export default class TestPlugin implements IPlugin {
private readonly config: any;
Expand All @@ -28,7 +28,7 @@ export default class TestPlugin implements IPlugin {
In the constructor you have access to any plugin specific config provided in the `.autorc`. It might be useful to write a more type-safe interface for your config.

```ts
import { AutoRelease, IPlugin } from 'auto-release-cli';
import { AutoRelease, IPlugin } from 'auto';

interface ITestPluginConfig {
foo?: string;
Expand Down
10 changes: 5 additions & 5 deletions package.json
@@ -1,5 +1,5 @@
{
"name": "auto-release-cli",
"name": "auto",
"description": "CLI tools to help facilitate semantic versioning based on GitHub PR labels",
"version": "2.10.4",
"main": "dist/main.js",
Expand All @@ -16,7 +16,7 @@
},
"repository": {
"type": "git",
"url": "https://github.com/intuit/auto-release"
"url": "https://github.com/intuit/auto"
},
"files": [
"dist"
Expand Down Expand Up @@ -134,11 +134,11 @@
]
},
"ignite": {
"title": "auto-release",
"baseURL": "/auto-release",
"title": "auto",
"baseURL": "/auto",
"logo": "logo.gif",
"bulmaTheme": "materia",
"githubURL": "https://github.com/intuit/auto-release",
"githubURL": "https://github.com/intuit/auto",
"customHead": "<style>.content p > .header-image { max-width: 200px !important; } .navbar { box-shadow: none !important; border-bottom: 1px solid lightgrey; } .list { font-size: 1.2rem; } .is-purple { background: #870048 !important; } .has-text-purple { color: #870048 !important; } .is-red { background: #C5000B !important; } .is-yellow { background: #F1A60E !important; } a.navbar-item.is-active, a.navbar-item:hover, a.navbar-link.is-active, a.navbar-link:hover { background-color: #f5f5f5;color: #870048; } .button.is-link.is-inverted.is-outlined:hover { background-color: #fff;color: #870048; } p .image { max-width: 100% !important; }.menu .menu-list a.is-active {background-color: transparent;color: #870048;}</style>",
"favicon": "favicon.png"
}
Expand Down

0 comments on commit 8213bd5

Please sign in to comment.