Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Update docs
  • Loading branch information
webpro committed Jan 15, 2019
1 parent 6164050 commit eb3c3f8
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 28 deletions.
24 changes: 16 additions & 8 deletions CHANGELOG.md
Expand Up @@ -2,18 +2,26 @@

This document lists breaking changes for each major release.

See the GitHub Releases page for detailed changelogs: [https://github.com/webpro/release-it/releases](https://github.com/webpro/release-it/releases)
See the GitHub Releases page for detailed changelogs:
[https://github.com/webpro/release-it/releases](https://github.com/webpro/release-it/releases)

## v10

- Dropped support for Node v6
- Deprecated options from v9 are removed, the `dist.repo` config in particular (also see
[distribution repository](https://github.com/webpro/release-it#distribution-repository) for alternatives).
- Drop the `--debug` flag. `DEBUG=release-it:* ...` still works.

## v9

There should be no breaking changes, but there have been major internal refactorings and an improved UI.
A bunch of new features and bug fixes have been implemented.
Last but not least, the configuration structure is changed significantly. For this (backwards compatible) change,
deprecation warnings are shown, and configurations must be migrated with the next major release (v10).
See [deprecated.json](./conf/deprecated.json) for the changes, mainly:
There should be no breaking changes, but there have been major internal refactorings and an improved UI. A bunch of new
features and bug fixes have been implemented. Last but not least, the configuration structure is changed significantly.
For this (backwards compatible) change, deprecation warnings are shown, and configurations must be migrated with the
next major release (v10). See [deprecated.json](./conf/deprecated.json) for the changes, mainly:

- All "command hooks" have been moved to `scripts.*`, and some have been renamed.
- All `src.*` options have been moved to `git.*` (and `scripts.*`)
- The `dist.repo` has been removed in v9.8.0

## v8

Expand All @@ -26,8 +34,8 @@ See [deprecated.json](./conf/deprecated.json) for the changes, mainly:
## v6

- Default value for `requireCleanWorkingDir` is now `true` (previously: `false`). (#173)
- Skip prompt (interactive) if corresponding task (non-interactive) is disabled.
E.g. `npm.publish: false` will also not show "publish" prompt.
- Skip prompt (interactive) if corresponding task (non-interactive) is disabled. E.g. `npm.publish: false` will also not
show "publish" prompt.

## v5

Expand Down
26 changes: 19 additions & 7 deletions CONTRIBUTING.md
Expand Up @@ -2,7 +2,12 @@

First of all, thanks for thinking of contributing to this project! 👏

This project has a [Contributor Covenant Code of Conduct](./CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
Following these guidelines helps to communicate that you respect the time of the maintainer and developing this open
source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping
you finalize your pull requests.

This project has a [Contributor Covenant Code of Conduct](./CODE_OF_CONDUCT.md). By participating in this project you
agree to abide by its terms.

## ❤️ Ways to Contribute

Expand All @@ -15,20 +20,25 @@ This project has a [Contributor Covenant Code of Conduct](./CODE_OF_CONDUCT.md).

## 🛎 Questions & Feature Requests

Feel free to [open a ticket](https://github.com/webpro/release-it/issues/new) with your question. Feature requests are also welcome. Describe the feature, why you need it, and how it should work. Please provide as much detail and context as possible.
Feel free to [open a ticket](https://github.com/webpro/release-it/issues/new) with your question. Feature requests are
also welcome. Describe the feature, why you need it, and how it should work. Please provide as much detail and context
as possible.

## 🐛 File a Bug

In case you've encountered a bug, please make sure:

- You are using the [latest version](https://github.com/webpro/release-it/releases).
- You have read the [documentation](https://github.com/webpro/release-it/blob/master/README.md) first, and double-checked your configuration.
- You have acknowledged from using `--verbose` and `--debug` the errors are likely a bug in this project, and not coming from e.g. your environment or custom scripts/commands.
- You have read the [documentation](https://github.com/webpro/release-it/blob/master/README.md) first, and
double-checked your configuration.
- You have acknowledged from [Troubleshooting & debugging](README.md#troubleshooting--debugging) the errors are likely a
bug in this project, and not coming from e.g. your environment or custom scripts/commands.
- In your issue description, please include:
- What you expected to see, and what happened instead.
- Your operating system and other environment information.
- As much information as possible, such as the command and configuration used.
- Interesting logs with `--verbose` and/or `--debug`. \* All steps to reproduce the issue.
- Interesting logs from a verbose and/or debug run.
- All steps to reproduce the issue.

## 🎁 Pull Requests

Expand All @@ -41,11 +51,13 @@ Please keep the following in mind:

- To match the existing code styling, use `npm run format` before committing code.
- Make sure the tests pass (run `npm test`). Your changes probably deserve new tests as well.
- Remember that this project is cross-platform compatible (macOS, Windows, Linux), and that it runs in different versions of Node.
- Remember that this project is cross-platform compatible (macOS, Windows, Linux), and that it runs in different
versions of Node. On PR submission, [Travis CI](https://travis-ci.org/webpro/release-it) will run the tests in
multiple supported platforms and Node.js versions.

Unsure about whether you should open a pull request? Feel free to discuss it first in a ticket.

[Fork](https://help.github.com/articles/fork-a-repo/) the repository, and set it up on your machine:
[Fork](https://help.github.com/articles/fork-a-repo/) the repository to get started, and set it up on your machine:

```bash
git clone https://github.com/<your-github-username>/release-it
Expand Down
29 changes: 17 additions & 12 deletions README.md
Expand Up @@ -21,9 +21,13 @@ CLI release tool for Git repos and npm packages.
[![Greenkeeper badge](https://badges.greenkeeper.io/webpro/release-it.svg)](https://greenkeeper.io/)
[![codecov](https://codecov.io/gh/webpro/release-it/branch/master/graph/badge.svg)](https://codecov.io/gh/webpro/release-it)

_See [CHANGELOG.md](CHANGELOG.md) for major updates and breaking changes. Refer to the
[releases](https://github.com/webpro/release-it/releases) section for a detailed version history. Want to help out, or
hack on release-it? Great! Please read [CONTRIBUTING.md](CONTRIBUTING.md) on how to participate._
## Links

- For **updates**, see [CHANGELOG.md](CHANGELOG.md) for major updates, and
[releases](https://github.com/webpro/release-it/releases) for a detailed version history.
- To **contribute**, please read [CONTRIBUTING.md](CONTRIBUTING.md) to participate.
- Please [open an issue](https://github.com/webpro/release-it/issues/new) if anything is missing or unclear in this
documentation.

<details>
<summary><strong>Table of Contents</strong> (click to expand)</summary>
Expand Down Expand Up @@ -104,8 +108,7 @@ release-it minor
release-it 0.8.3
```

For versions like `1.0.0-beta.2` and npm tags, see [manage pre-releases](#managing-pre-releases). For a "dry run", to
show the interactivity and the commands it _would_ execute:
For a "dry run", to show the interactivity and the commands it _would_ execute:

```bash
release-it --dry-run
Expand Down Expand Up @@ -334,8 +337,9 @@ The [default command](conf/release-it.json) is based on `git log ...`. This sett
overridden, or specifically with `github.releaseNotes` or `gitlab.releaseNotes` for the release notes only. Make sure
the command outputs the changelog to `stdout`.

Some projects keep their changelog in e.g. `CHANGELOG.md` or `history.md`. In this case, the recommended configuration
is to use a command that does this in `scripts.beforeStage`. See below for examples and workflows.
Some projects keep their changelog in e.g. `CHANGELOG.md` or `history.md`. To auto-update this file with the release,
the recommended configuration is to use a command that does this in `scripts.beforeStage`. See below for examples and
workflows.

### Auto-changelog

Expand Down Expand Up @@ -464,7 +468,7 @@ Consecutive beta releases (`2.0.0-beta.1` and so on):
release-it --preRelease
```

And when ready to release the next phase (e.g. release candidate):
And when ready to release the next phase (e.g. release candidate, in this case `2.0.0-rc.0`):

```
release-it --preRelease=rc
Expand All @@ -481,7 +485,7 @@ release-it major
Notes:

- Pre-releases can work together with [recommended bumps](#recommended-bump).
- You can still override individual options (e.g. `release-it --preRelease=rc --npm.tag=next`).
- You can still override individual options, e.g. `release-it --preRelease=rc --npm.tag=next`.
- See [semver.org](http://semver.org) for more details about semantic versioning.

## Scripts
Expand Down Expand Up @@ -536,9 +540,10 @@ development.

## Troubleshooting & debugging

- Use `--verbose` to output commands that release-it executes.
- Use `--debug` to output configuration and additional (error) logs.
- Use `DEBUG=octokit:rest* release-it [...]` for debug logs with GitHub releases & assets.
- With `release-it --verbose`, release-it prints every command and its output.
- Prepend `DEBUG=release=it:* release-it [...]` to print configuration and more error details.
- Use `DEBUG=* release-it [...]` to include debug output for dependencies, such as
[@octokit/rest](https://github.com/octokit/rest.js).

## Use release-it programmatically

Expand Down
4 changes: 3 additions & 1 deletion package.json
Expand Up @@ -8,6 +8,7 @@
"distribution",
"git",
"github",
"gitlab",
"interactive",
"npm",
"publish",
Expand All @@ -18,7 +19,8 @@
"shell",
"tag",
"tool",
"version"
"version",
"semver"
],
"repository": {
"type": "git",
Expand Down

0 comments on commit eb3c3f8

Please sign in to comment.