208 Commits

Author SHA1 Message Date
Matt Travi
d9605a5e45
docs(node-version): updated documentation to reference the new minimum 2021-07-30 15:47:49 -05: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
Mo Sattler
7581aa8584
docs: fix a typo in github-actions.md (#1735) 2021-01-15 09:35:05 -06:00
cherryblossom000
e211499735
docs(plugins): document addChannel step (#1721)
Document the `addChannel` step defined in
e35e5bb73f/lib/definitions/plugins.js (L83-L84),
which is used in @semantic-release/npm.
2020-12-29 12:33:12 -08:00
Mihai Plasoianu
6c7e4be68a
docs: add semantic-release-helm plugin (#1713) 2020-12-09 09:22:32 -08:00
abichinger
c177d4b15a
docs: add semantic-release-pypi plugin (#1707) 2020-12-02 09:43:00 -08:00
Geoffroy Empain
eb708236df
docs: add semantic-release-license-plugin (#1701)
This adds a semantic-release-plugin which we use to update our license files (copyright dates and more) based on their type.
2020-11-25 09:25:48 -08:00
Almenon
885d87ac0f
feat(docs): note that publish token is required (#1700)
see https://github.com/semantic-release/npm/issues/277
2020-11-22 10:38:15 -08:00
Amanda Mitchell
63fa143023
docs(plugins): add listing for new plugin (#1686) 2020-11-12 14:16:15 -08:00
Guillaume Gautreau
d74ffef788
docs: add npm-deprecate-old-versions in plugins list (#1667) 2020-10-23 14:26:20 -07:00
Graeme Cassels
18e35b28ad
docs: reorder default plugins list (#1650)
Reorder the list default plugins from alphabetical to order of execution.
2020-10-04 11:52:17 -07:00
Joep Kockelkorn
9635f50da6
docs: improve github actions recipe on git plugin (#1626) 2020-09-06 10:38:29 -07:00
ylemkimon
d036a899d5
ci(docs): use actions/checkout@v2 (#1620) 2020-08-17 16:26:13 -07:00
AbdelRahman Wahdan
9303d1dba0
docs(resources.md): added more sematnic release article (#1610) 2020-07-30 17:17:36 -07:00
kopal
b72cdb331b
docs(configuration.md): Updated documentation for dry-run feature of semantic Release (#1607) 2020-07-29 15:25:32 -07:00
Ahmed Hassanein
ee44ee80c8
docs(github-actions): suggest action_dispatch as trigger (#1605) 2020-07-28 06:57:05 -07:00
Rylan Collins
b24d2474b1
docs: add semantic-release-rubygem to community plugins (#1602) 2020-07-22 16:35:05 -07:00
Gavin Staniforth
6d118c6c14
docs: be clear about what module of semantic-release handles updating the package.json (#1601) 2020-07-12 12:31:40 -07:00
Shun Kakinoki
b5c9dea215 docs: update github documentation to docs.github.com 2020-07-09 22:44:15 -05:00
kopal
1405b94296
docs: added recipe for Jenkins CI configuration (#1) (#1591) 2020-06-30 14:54:33 -07:00
Sven Liebig
a4658016d9
feat(bitbucket-basic-auth): support for bitbucket server basic auth (#1578) 2020-06-22 11:26:24 -07:00
Daniel Tschinder
5f3a8bb14e
docs: Recommend using npx instead of installing globally (#1563) 2020-05-24 10:20:58 -07:00
Lucas Shadler
0ef52e7a5f
docs: adjust minor typos (#1554) 2020-05-19 14:15:26 -07:00
Aaron Batilo
a62bc7cd85
docs(GitHub Actions): Add alternative trigger options (#1471)
These options work the same as the curl command, but use a GitHub App so there's no need to provision and manage a Personal Access Token in order to trigger the Semantic Release action.
2020-05-06 11:50:31 -07:00
solidnerd
22321cff1c docs: update recipe for gitlab-ci with Node.js >=10.18
Signed-off-by: solidnerd <niclas@mietz.io>
2020-04-22 15:15:05 -07:00
Justin Poehnelt
ff1d53df58
docs: add @google/semantic-release-replace-plugin to plugin list (#1509) 2020-04-02 16:23:31 -07:00
Gaurav Nelson
da5d06cf78
docs: fix formatting for GitBook 2020-02-27 02:52:32 -05:00
Raphaël Huchet
ec516a34bf
docs(configuration): fix CLI usage with --branches option (#1465) 2020-02-17 10:05:33 -08:00
Gregor Martynus
804fc2a943
docs(Troubleshooting): release not found in prereleases branch (e.g. beta) after rebase on master) (#1444) 2020-02-08 11:03:48 -08:00
Mario Lubenka
c7e461dc1c docs: add @saithodev/semantic-release-gitea to community plugins 2020-01-27 14:23:38 -05:00