236 Commits

Author SHA1 Message Date
iczellion
c69445ebea
docs: remove deprecated keyword in gitlab-ci.md (#2498) 2022-07-06 02:54:22 +00:00
HonkingGoose
9589a96239
docs: fix typos (#2476) 2022-06-16 12:57:37 -07:00
HonkingGoose
db620aa799
docs: fix typo (#2473) 2022-06-16 11:35:02 -07:00
HonkingGoose
dd77f1f603
docs: fix typo (#2472) 2022-06-16 11:34:41 -07:00
HonkingGoose
e66b4b59c0
docs: drop duplicate word (#2471) 2022-06-16 11:34:25 -07:00
HonkingGoose
3387fb756d
docs: fix typo (#2468) 2022-06-16 11:34:11 -07:00
Cesar S
587bb91c9a
docs(configuration.md): addChannel step is skipped when dryRun is enabled (#2465)
Add `addChannel` to the list of steps that are skipped by dryRun=true
2022-06-13 22:08:53 -07:00
Bolaji Ayodeji
2b94bb4e09
docs: update broken link to CI config recipes (#2378) 2022-02-23 11:34:41 -06:00
hong-jen kao
b4bc1918cb
docs: Correct circleci workflow (#2365) 2022-02-17 20:12:26 +00:00
Jaime Gómez-Obregón
dd7d664aa1
docs: fix a broken link (#2318) 2022-01-07 17:28:12 +00:00
Federico D'Eredità
cd6136d67e
docs: wrong prerelease example (#2307)
The documentation says:

> If the `prerelease` property is set to `true` the `name` value will be used.

But then the example referring to this behaviour has the the `prerelease` value set to `'beta'` instead of `true`.
2021-12-21 09:24:12 -08:00
Rommy Gustiawan
e62c83d805
docs: remove repeated 'with' word (#2289) 2021-12-07 16:38:58 +00:00
Eric Crosson
5535268ad0
docs: fix typo (#2262) 2021-11-24 10:05:42 -06:00
Takuya Fukuju
e6366211bb
docs(troubleshooting): typo (#2254) 2021-11-21 09:09:29 -08:00
Matt Travi
8fda7fd423
docs(recipes): moved recipes to sub-directories to align with gitbook expectations (#2246) 2021-11-14 10:35:20 -08:00
Justin Dietz
52d76a2a97
docs(plugin-list): updates semantic-release-plus/docker with updated lifecycle hook. (#2243) 2021-11-12 16:07:34 -08:00
Matt Travi
bc146e49b1
docs(gitbook): updated the summary document so that missing pages are rendered by gitbook (#2234) 2021-11-07 20:50:14 -08:00
Ievgenii Shepeliuk
b2b07bfc00
docs(plugins): add @eshepelyuk/semantic-release-helm-oci to plugins list (#2211)
Signed-off-by: Ievgenii Shepeliuk <eshepelyuk@gmail.com>
2021-10-30 20:32:38 +00:00
Justin Poehnelt
2ef403eb98
docs: add semantic-release-npm-deprecate plugin (#2210) 2021-10-29 12:52:53 -07:00
Matt Travi
0d0e0a1d8f
docs(node-version): consolidated and clarified the details about the required node version (#2170) 2021-10-24 02:27:16 -05:00
Justin Dietz
8db804b7dc
docs: fix plugin example (export verifyConditions, not verify) (#2192)
plugin example was exporting `verify`, not `verifyConditions`
2021-10-18 11:50:50 -07:00
askoropad
a50dc996b5
docs(plugins): add telegram-bot plugin to the plugin list (#2190) 2021-10-14 19:31:45 +00:00
Nitzan Ohana
0495cb67b2
docs: add semantic-release-github-milestones plugin (#2181) 2021-10-11 20:26:03 +00:00
HonkingGoose
74671f809c
docs(github-actions): update workflow version, update node-version (#2175) 2021-10-05 09:20:34 -05:00
ttrobisch
f79e27f588
docs: add semantic-release-mattermost to the plugin list (#2163) 2021-10-01 16:47:58 +00:00
Justin Poehnelt
0ce4846b68
docs: add section on logger usage for plugins (#2139) 2021-09-21 15:52:17 -07:00
Matt Travi
66cc2b4c7f
feat(node-version): raised the minimum required version to v14.17 (#2132)
BREAKING CHANGE: the minimum required version of node is now v14.17
2021-09-17 13:05:32 -07:00
Roz
23d2bc2842
docs: fix broken link on github actions recipe (#2102)
The link to the secrets and environment variables was broken since the documentation changed.
I pointed the link to the URL that made most sense, since users can choose to create the secret wherever they want.
2021-09-03 16:40:59 +00:00
Matt Travi
ea52e1775a
fix(engines): fixed defined node version to account for the higher requirement from the npm plugin (#2088) 2021-08-25 12:01:16 -07:00
Hugh Rawlinson
04b6046e1f
docs(branches): minor typo fixes (#2033) 2021-07-17 14:53:43 -07:00
Kyle T
413ffd2a4b
docs(circleci): Update CircleCI recipes config (#2018)
Updates the included CircleCI config file example.

* Now uses 2.1 style config
* Uses Node Orb
* Use pre-defined node/test job
* Uses Matrix jobs to test multiple node versions.
* Updated Node versions
* Using new CircleCI docker images (from node executor)
* Updated language/terminology in description
2021-07-08 13:14:29 -07:00
Moritz Wiesinger
cf000687c4
docs(recipes): fix some typos (#1999)
Signed-off-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com>
2021-07-01 09:17:34 -07:00
Fernando Rojo
1463eb42cb
docs(plugins): clarify order of execution (#1989) 2021-06-25 14:06:57 -05:00
Justin Dietz
7452eaf2cd
docs: adds updated docker plugin that supports major, minor tagging (#1963) 2021-06-03 09:31:49 -07:00
Aki Mäkinen
fe0ac417cf
docs(plugin developer guide): correction, additional details / advanced (#1961)
A correction to the earlier documentation: the "nextRelease" object is NOT similar to the
lastRelease and there are some differences. Because of this, the object is now documented as a
separate entry. Added also information on how the error handling should be done so that
semantic-release would be able to handle errors from plugins properly and call "fail" lifecycle
plugins. Included some more advanced information on how the analyzeCommits-lifecycle plugins work
and how the result of the initial analyzer can be overridden. This is an edge case, but could happen
and is good to understand.
2021-05-31 10:15:47 -07:00
Josh Sullivan
6427210b83
docs(workflow-configurator): fix single typo (#1892) 2021-05-26 10:57:54 -07:00
Dmytro Pustovit
7fbab56a98
docs: add semantic-release-telegram to the list of community plugins (#1945)
Co-authored-by: Gregor Martynus <39992+gr2m@users.noreply.github.com>
2021-05-21 14:30:44 -07:00
Dmytro Pustovit
7dae2a9f43
docs: add heroku to list of community plugins (#1920) 2021-05-21 14:29:28 -07:00
Ryan Sonshine
13f6a725a1
docs(plugins-list): add semantic-release-codeartifact (#1939) 2021-05-17 07:50:18 -07:00
mhagnumdw
e24ef71e33
docs(distribution-channels): fix branch name (#1925) 2021-05-09 22:40:32 -05:00
Aki Mäkinen
0435e35fee
docs(Plugin Developer Guide): More detailed lifecycle list and context descriptions (#1880)
* docs(Plugin Developer Guide): More detailed lifecycle list and context descriptions

This commit will improve the following in the Plugin developer guide:
  * Lifecyle list more complete (previous was missing some lifecycles)
  * Context object has been now described in more detail per lifecycle
  * Some readability/maintainability fixes to the markdown file itself
    to make it easier to edit and read in an editor.

* docs(Plugin Developer Guide): Added missing context field to analyzeCommits lifecycle documentation

analyzeCommits lifecycle context was missing documentation for "commits" list.

* docs(developer-guide): remove line breaks added in an earlier commit

As per requested in the code review, the line breaks that were added in an earlier commit are now
removed. While this does make reading the text just slightly more difficult (to see the whole
picture), the benefit of making code reviews easier does outweight the admittedly small benefit.
2021-04-25 15:14:03 -07:00
Aki Mäkinen
72522c3570
docs(Plugin Developer Guide): Update lifecycle list (#1874)
The old list was missing analyzeCommits lifecycle and the verification lifecycle was incorrectly listed as "verify", when it should currently be "verifyConditions" in order to properly load.
2021-04-07 14:47:41 -07:00
Oscar Dominguez
5489489dda
docs(github-actions): example suggests using ubuntu-latest (#1867)
instead of a concrete version of Ubuntu
2021-03-31 10:39:08 -07:00
Mohammed ragab ali
12337175c6
docs: Add article to explain semantic release (#1856) 2021-03-30 10:32:07 -07:00
Kristian Heljas
2e4b901c4f
docs: use consistent version number for tag recovery (#1857) 2021-03-24 09:19:06 -07:00
Lukas
48def0c4cc
docs: fix links to gitlab releases documentation (#1834) 2021-03-07 12:44:08 -08:00
Micael Jarniac
acf8bc4d21
docs: fix missing whitespace (#1821) 2021-02-24 16:20:35 -08:00
mcnesium
a9be97b56b
fix: update link to GitLab CI introduction (#1794) 2021-02-12 13:45:36 -08:00
Alexis Saettler
85bc213f04
docs: add semantic-release-github-pullrequest to list of community plugins (#1790) 2021-02-11 09:09:58 -08:00
Vegard Økland
c5719101cc
docs: clarify node vs npm in FAQ (#1731) thanks @vegardok 2021-01-15 11:50:33 -08:00