Alisson R. Perez
f645547f2f
docs(recipes): GitHub actions ( #1317 )
...
Co-Authored-By: Natan Sągol <m@merlinnot.com>
2019-10-23 10:47:24 -07:00
Pierre Vanduynslager
6f33c76fde
docs: various clarifications and language improvvements
2019-08-22 14:47:21 -04:00
Pierre Vanduynslager
4b13280713
docs: correct list of default plugins
2019-08-22 14:47:21 -04:00
Pierre Vanduynslager
e00b6c84df
revert: docs: repared broken links to "CI configuration recipes"
...
This reverts commit 3f229786233e87a4e5e8d1d812a23cc7edc98bb2.
2019-08-22 14:47:21 -04:00
Pierre Vanduynslager
5e41dc89bd
revert: docs: made doc file org clearer and augmented content
...
This reverts commit 5a5eaec3da5e3be4a505f6c5e7fa9eb81d202cea.
2019-08-22 14:47:21 -04:00
Emmanuel Sciara
5a5eaec3da
docs: made doc file org clearer and augmented content
...
This is a first step to improving the doc: - renamed directories; - augmented a fair bit of content.
To be continued
2019-07-31 14:40:10 -07:00
Emmanuel Sciara
3f22978623
docs: repared broken links to "CI configuration recipes"
2019-07-30 16:13:59 -07:00
Debjeet Biswas
3b8cae91fa
docs: fix typo
...
fix misspelled `they`
2019-07-02 15:09:54 -07:00
Rob Cresswell
228fed7a0b
docs: document that plugins config is an override ( #1216 )
...
This patch documents that the `plugin` config option is an override, not
a merge with the default. This is significant, for example, if you
customise the github plugin as it will then prevent npm publishing by
default unless the npm plugin is also defined manually.
2019-06-25 13:01:55 -07:00
Johannes Klein
d4520e10ed
doc: add info about default plugins
2019-06-04 14:07:01 -07:00
Brett Zamir
c8ec0fd67f
docs: fix grammar
2019-05-08 14:32:55 -04:00
David Aghassi
6a8eede96f
docs: cleaned up wording and typos in docs
2019-01-12 14:27:56 -05:00
Pierre Vanduynslager
0f642ffe4d
docs: remove mentions of travis-deploy-once
2018-12-14 10:48:58 -08:00
Pierre Vanduynslager
649b53087a
docs: mention that debug
option is CLI only
2018-12-11 13:33:06 -05:00
Andy Edwards
d6d1bc954e
docs: grammar corrections
2018-11-27 16:04:50 -05:00
Kostis (Codefresh)
244f014a91
docs: add Codefresh in list of CIs with pipelines
2018-11-18 14:59:12 -05:00
Pierre Vanduynslager
5180001ae6
feat: support multiple plugins for the analyzeCommits
step
...
In case multiple plugins with a `analyzeCommits` step are configured, all of them will be executed and the highest release type (`major` > `minor`, `patch`) will be used.
2018-11-12 15:06:46 -05:00
Pierre Vanduynslager
83af7acf69
docs: mention default analyzeCommits
plugin
2018-11-12 15:06:46 -05:00
Pierre Vanduynslager
e29110103b
docs: add section existing tags in configuration docs
2018-10-09 22:02:34 -04:00
Pierre Vanduynslager
e93a663490
docs: fix markdown link in configuration docs
2018-10-09 22:02:34 -04:00
Jamie Barton
3e8216ab35
docs: typo in configuration docs
2018-10-09 12:20:35 -04:00
Pierre Vanduynslager
aa9d5c6efe
docs: add a Getting started
section and clarify config steps
2018-10-08 13:24:51 -04:00
Pierre Vanduynslager
5ba5010c80
feat: add new plugins
option
2018-10-08 13:24:51 -04:00
Patrick Mowrer
1348985b6c
docs: analyzeCommits
does not accept an Array
...
[Fixes #924 ]
2018-09-07 10:17:06 -04:00
Pierre Vanduynslager
dfbb9f2429
docs: clarify the URL encoding of GIT_CREDENTIALS
2018-09-05 14:05:08 -04:00
Pierre Vanduynslager
468f8a8bda
docs: clarify the --ci
/ --no-ci
CLI option
2018-09-03 14:21:55 -04:00
Pierre Vanduynslager
b2d82c2ccb
docs: specify for each step if one or more plugins are required/allowed
2018-07-29 23:50:17 -04:00
Pierre Vanduynslager
31ec1eb5de
docs: fix configuration doc syntax
2018-07-29 23:50:17 -04:00
Pierre Vanduynslager
d8c84a0e0b
fix: clarify EPLUGINCONF
error message
...
The message now specify if the step is required and if it allows to configure multiple plugins.
2018-07-29 23:50:17 -04:00
Pierre Vanduynslager
5989989452
feat: allow to define multiple generateNotes
plugins
...
Each `generateNotes` plugin will be called in the order defined and will receive the concatenation of the previous one in `nextRelease.notes`.
That gives each plugin the ability to test if there is a notes part that will precede it's own.
Each plugin is expected to return it's own part of the release notes only. **semantic-release** will take care of concatenating all the notes parts.
2018-07-10 13:18:58 -04:00
Pierre Vanduynslager
d3032868d8
docs: fix default value for analyzeCommits
plugin
2018-07-10 13:18:58 -04:00
Pierre Vanduynslager
cac48823f1
docs: clarify verifyRelease
plugin description
2018-07-10 13:18:58 -04:00
Pierre Vanduynslager
3602716c0b
docs: update semantic-release
and travis-deploy-once
versions in examples
2018-07-02 11:23:37 -04:00
Trevor Richardson
7615fdc9bc
Fix documented explanation in plugins.md
...
`verifyConditions` explanation was wrong previously.
2018-06-18 10:52:27 -04:00
Pierre Vanduynslager
4d47b20831
docs: clarify config file format
2018-06-04 15:12:46 -04:00
Pierre Vanduynslager
61d7d38ec2
feat: set tag author and committer name/email
...
Use [Git Environment Variables](https://git-scm.com/book/en/v2/Git-Internals-Environment-Variables#Committing ). Set default values if environement variables are not set.
2018-05-08 14:25:23 -04:00
Pierre Colle
f0f325dd7f
docs: add link to shareable configs and plugins list
2018-05-04 20:32:45 -04:00
pvdlg
c93775cc38
feat: add support for Bitbucket token in environment variables
2018-05-01 12:02:29 -07:00
Kévin Berthommier
a1138a6a80
docs: update plugins package name
2018-04-11 18:40:19 -04:00
William Hosford
e41726cb96
docs: fix grammar and typos in CI configuration, configuration, and shareable configurations
2018-03-21 20:03:21 -07:00
Pierre Vanduynslager
5f1d530e2a
feat: allow to use shorthand for repositoryUrl
...
- `owner/repo` => `https://github.com/owner/repo.git `
- `gitlab:owner/repo` => `https://gitlab.com/owner/repo.git `
- `bitbucket:owner/repo` => `https://bitbucket.com/owner/repo.git `
2018-03-15 22:40:09 +00:00
Gregor Martynus
1129d47e1d
docs(configuration): environment variable DEBUG
must be set to semantic-release:*
, not semantic-release
2018-03-12 16:39:46 -04:00
William Hosford
a7c187f31b
docs: fix grammar and typos in README, CONTRIBUTING, installation guide, and plugin guide
2018-02-25 17:43:51 +00:00
Pierre Vanduynslager
c2beb643fa
feat: add the prepare
plugin hook
...
BREAKING CHANGE: Committing or creating files in the `publish` plugin hook is not supported anymore and now must be done in the `prepare` hook
Plugins with a `publish` hook that makes a commit or create a file that can be committed must use the `prepare` hook.
2018-02-19 00:28:50 -05:00
Pierre Vanduynslager
9788fcad4e
feat: use @semantic-release/github
as default for success
and fail
hooks
...
BREAKING CHANGE: `success` and `fail` hooks are now enabled by default
In order to disable the `@semantic-release/github` plugin for the `success` and `fail` hook, the corresponding options have to be set to `false` in the **semantic-release** configuration:
```json
{
"release": {
"success": false,
"fail": false
}
}
```
Users who do not use the `@semantic-release/github` plugin, should disable it in the `success` and `fail` by setting the corresponding options to `false` or to alternative plugin providing `success` and `fail` hooks.
2018-02-13 16:33:37 -05:00
Pierre Vanduynslager
1b3c51d624
docs: add missing success
and fail
options
2018-02-13 16:06:30 -05:00
Pierre Vanduynslager
49f5e704ba
feat: add success
and fail
notification plugins
...
- Allow `publish` plugins to return an `Object` with information related to the releases
- Add the `success` plugin hook, called when all `publish` are successful, receiving a list of release
- Add the `fail` plugin hook, called when an error happens at any point, receiving a list of errors
- Add detailed message for each error
2018-02-11 19:53:41 -05:00
Pierre Vanduynslager
39536fa34e
feat: add tagFormat
option to customize Git tag name
2018-01-29 00:55:32 -05:00
Anthony Ng
2f75dff3fc
docs: fix image path ( #625 )
2018-01-28 14:01:12 -08:00
Stephan Bönnemann
e3c9bb8bd4
docs: recommend to execute semantic-release via npx
2018-01-27 19:04:12 -08:00