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.

Sign up for GitHub

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

Add Contributor documentation #38

Merged
merged 3 commits into from
Dec 8, 2018
Merged

Add Contributor documentation #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c3af50d
upgrade ignite
hipstersmoothie Dec 8, 2018
57678bd
add contributing docs
hipstersmoothie Dec 8, 2018
f40143d
add quick setup docs tanks to `shipit` and link to autorc everywhere
hipstersmoothie Dec 8, 2018
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
44 changes: 43 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<p>Generate releases based on semantic version labels on pull requests</p>
</div

[![Codecov](https://img.shields.io/codecov/c/github/intuit/auto-release.svg?style=for-the-badge)](https://codecov.io/gh/intuit/auto-release) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier) [![CircleCI](https://img.shields.io/circleci/project/github/intuit/auto-release/master.svg?style=for-the-badge)](https://circleci.com/gh/intuit/auto-release) [![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=for-the-badge)](#contributors) [![npm](https://img.shields.io/npm/v/auto-release-cli.svg?style=for-the-badge)](https://www.npmjs.com/package/auto-release-cli) [![npm](https://img.shields.io/npm/dt/auto-release-cli.svg?style=for-the-badge)](https://www.npmjs.com/package/auto-release-cli)
[![CircleCI](https://img.shields.io/circleci/project/github/intuit/auto-release/master.svg?style=for-the-badge)](https://circleci.com/gh/intuit/auto-release) [![Codecov](https://img.shields.io/codecov/c/github/intuit/auto-release.svg?style=for-the-badge)](https://codecov.io/gh/intuit/auto-release) [![npm](https://img.shields.io/npm/v/auto-release-cli.svg?style=for-the-badge)](https://www.npmjs.com/package/auto-release-cli) [![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors) [![npm](https://img.shields.io/npm/dt/auto-release-cli.svg?style=for-the-badge)](https://www.npmjs.com/package/auto-release-cli) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier)

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

Expand All @@ -25,6 +25,44 @@ Pull Request Interaction Features:

Visit [the docs](https://intuit.github.io/auto-release/) for more information.

## Start Developing

To get set up, fork and clone the project and run the following command:

```sh
yarn
```

### Linting

```sh
yarn lint
```

### Testing

```sh
yarn test
```

### Build/Typecheck

```sh
yarn build
```

### Run the docs

```sh
yarn docs:watch
```

### Contributing

Feel free to make and [issue](https://github.com/intuit/auto-release/issues) or open a [pull request](https://github.com/intuit/auto-release/pulls)!

Make sure to read our [code of conduct](./CODE_OF_CONDUCT.md).

## Contributors

Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
Expand All @@ -37,3 +75,7 @@ Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds
<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!

### Adding a Contributor

To add a contributor run `yarn contributors:add`, choose "Add new contributor or edit contribution type" and follow the prompts.
2 changes: 1 addition & 1 deletion docs/pages/auto-changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Optional arguments:

## Jira

To include Jira story information you must include a URL to your hosted JIRA instance as a CLI or `.autorc` config option.
To include Jira story information you must include a URL to your hosted JIRA instance as a CLI or [.autorc`](./autorc.md) config option.

## Changelog Titles

Expand Down
22 changes: 17 additions & 5 deletions docs/pages/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,21 @@ Before we do anything we must first install `auto-release-cli` as a dev dependen
yarn add -D auto-release-cli
```

## Setup
## Quick Setup

The simplest workflow to get set up is adding the following to your `package.json`. With this setup your application will not be able to use the `no-release` flag, but everything else will work just fine
To version, changelog, publish and release your code in all at the same time, we've included the `shipit` tool. This tool takes the default `auto` workflow and puts it into one command.

```json
{
"scripts": {
"release": "auto shipit"
}
}
```

## Detailed Setup

The simplest workflow to get set up in just the `package.json` is by adding the following to your `package.json`. With this setup your application will not be able to use the `no-release` flag, but everything else will work just fine

```json
{
Expand All @@ -20,9 +32,9 @@ The simplest workflow to get set up is adding the following to your `package.jso
}
```

## Enabling `no-release` label
### Enabling `no-release` label

To use the `no-release` label you have to use a little more involved bash script. We could do the if checks in the `package.json` but this would get messy and hard to read. So instead in your package.json use a shell script defined in the project.
To use the `no-release` label you have to get a little more involved and use a shell script. We could do the `if` checks in the `package.json`, but this would get messy and hard to read very quickly.

```json
{
Expand Down Expand Up @@ -70,4 +82,4 @@ fi

## 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 `--githubApi` or by setting the value in your `.autorc`.
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 `--githubApi` or by setting the value in your [.autorc](./autorc.md#githubApi).
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
"@types/url-join": "^0.8.2",
"all-contributors-cli": "^5.4.1",
"husky": "^1.2.0",
"ignite": "^1.6.2",
"ignite": "^1.6.3",
"jest": "~23.6.0",
"lint-staged": "^8.1.0",
"prettier": "^1.15.3",
Expand Down
8 changes: 4 additions & 4 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6096,10 +6096,10 @@ iferr@^0.1.5:
resolved "https://registry.yarnpkg.com/iferr/-/iferr-0.1.5.tgz#c60eed69e6d8fdb6b3104a1fcbca1c192dc5b501"
integrity sha1-xg7taebY/bazEEofy8ocGS3FtQE=

ignite@^1.6.2:
version "1.6.2"
resolved "https://registry.yarnpkg.com/ignite/-/ignite-1.6.2.tgz#3f6b938d8d57b854332adf5ab736bd7b4dfcb934"
integrity sha512-Sl8n8amuJRe5LNl6V+0UFJA3XDpIl1zPKtDYZ4IM36Uu8gr4ACo0r81/zx/4T3rSY7nGZCHIBG9r44W6JaiUAQ==
ignite@^1.6.3:
version "1.6.3"
resolved "https://registry.yarnpkg.com/ignite/-/ignite-1.6.3.tgz#e52500fee1e4ddbfc76edf9b78d409ade6dc1f62"
integrity sha512-Yq95LwC/EB5E6MhiLPmLgfP3JaZTEahgvxlarrQdNHXCSZvxTT1UFAD4HuiPHye2OahpTa8vC1/3/ntaHR62xg==
dependencies:
"@babel/cli" "7.0.0"
"@babel/core" "7.0.0"
Expand Down