122 Commits

Author SHA1 Message Date
Olabode Lawal-Shittabey 1beed123fa feat: integrate @semantic-release/core engine (#4256)
This pull request refactors the core logic of the package to use the
`@semantic-release/core` engine directly, removes legacy and duplicated
code, and centralizes configuration. The changes simplify the codebase
by delegating most of the release logic to the upstream core package,
making the CLI wrapper thinner and easier to maintain. Several internal
utility files for branch and tag handling are also removed, as their
logic is now handled by `@semantic-release/core`.

### Migration to Core Engine

* The CLI now delegates release logic to `@semantic-release/core`, using
its `resolveConfig`, `getLogger`, and other helpers, instead of
maintaining a custom implementation. This reduces maintenance overhead
and ensures alignment with the core release logic.
* The documentation is updated to explain that `semantic-release` uses
`@semantic-release/core` as its engine, and provides guidance for
advanced use cases.

### Configuration and Defaults

* A new `SEMANTIC_RELEASE_DEFAULT_CONFIG` constant is introduced,
centralizing the default plugin stack for releases.

### Codebase Simplification

* Removes internal implementations for branch expansion, tag retrieval,
and normalization, as well as related validation and error handling
logic. These are now handled by the core engine.
2026-10-06 06:42:49 +01:00
Olabode Lawal-Shittabey 1114416a5b chore: remove 'next version' badge from README (#4265)
Removed the 'next version' badge from README.
2026-07-27 10:21:26 +01:00
Olabode Lawal-Shittabey d871161133 Merge pull request #4209 from semantic-release/chore/docs
docs: integrate new doc site
2026-06-17 10:17:02 -07:00
Olexandr88 fe22721732 docs(social): removed the link to the social network Twitter (#3926)
Co-authored-by: Olabode Lawal-Shittabey <babblebey@gmail.com>
2025-11-10 14:57:30 -06:00
Aaron Joyce a4251f705a docs: update angular commit message guidelines link (#3670)
Angular has moved their commit message guidelines from a section of the README into a separate markdown file. This PR fixes the link to point at the correct location.
2025-04-06 16:40:02 +00:00
Olabode Lawal-Shittabey 6b9366b8c1 doc(README): fix CI status badge (#3342)
Update README.md
2024-06-10 12:38:56 -07:00
Tim Fisher 95d8736011 feat: add main branch to default release branch config (#1737)
Co-authored-by: Andrei Danilov <andreialexandr.danilov@gmail.com>
Co-authored-by: Oriol Torrillas <otorrillas@gmail.com>
Co-authored-by: Matt Travi <126441+travi@users.noreply.github.com>
2024-05-07 22:30:07 -05:00
Matt Travi afc7518c50 docs: fixed links
fixes #3114
2023-12-18 22:11:31 -06:00
Thomas Briot 3d8c7154b2 docs: fix broken link to 'sentimental versioning' resource (#3067) 2023-11-19 21:20:11 -06:00
Matt Travi 9ebabe1266 ci(ossf-scorecard): added workflow calculating scorecard metrics (#2848) 2023-06-25 21:44:40 -05:00
Liran Tal f1b0801157 docs: Update README.md with npm package provenance (#2789) 2023-05-08 21:06:39 -05:00
Gregor Martynus d13ea9280e style: prettier (#2624) 2022-11-23 16:02:51 -08:00
Matt Travi 5d78fa4045 docs(breaking-change): highlighted the need for BREAKING CHANGE: to be in the commit footer (#2283)
since this is a common confusion point for new folks
2021-12-02 10:06:37 -08:00
Matt Travi b64855fc57 docs(badge): mentioned referencing the commit convention (#2269) 2021-11-26 11:13:26 -08:00
Takuya Fukuju 09bcf7a86d docs: update badges to include preset names (#2266) 2021-11-25 23:31:49 -06:00
Max Brauer f2a2deffc1 docs(recipes): fix path to recipes (#2253)
* removes link to unknown “package managers and languages” recipes
2021-11-20 14:45:06 +00: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
Matt Travi 03aa7d0d50 docs(badge): switched to proper semantic-release logo (#2235) 2021-11-08 13:48:25 -06: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
Matt Travi 7faa7993eb docs(readme): minor updates, including formating and minor clarification (#2168) 2021-10-01 16:55:07 +00: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
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
HonkingGoose 29d34788ff docs(README): improve sentence (#1962) 2021-06-01 13:48:53 -07:00
Kiran Koirala 67dfb676bc docs(README): change link to Angular's Contribution guidelines instead of Angular.js's Developers guide (#1817) 2021-02-23 10:42:30 -08:00
Matt Travi 8e3a6cbef2 docs(discussions): updated spectrum references to point to discussions instead (#1782)
for #1764
2021-02-09 08:22:21 -08:00
Gregor Martynus b5aa853b22 ci: replace travis with actions, setup renovate (#1699)
Co-authored-by: Josh Soref <jsoref@users.noreply.github.com>
2021-01-20 14:07:16 -08:00
Gregor Martynus 311c46580f docs(README): welcome @travi, add alumni section 2020-09-25 15:31:11 -07:00
Pierre Vanduynslager bec57cd2ed chore: require Node.js >=10.18
BREAKING CHANGE: Require Node.js >= 10.18
2020-01-27 13:52:59 -05:00
Michaël De Boey 559c152647 docs(README): update minimal required Node version / FAQ link (#1422) 2020-01-20 12:06:39 -08:00
Pierre Vanduynslager 2ec856eb1d docs: add requirements section to README 2019-11-01 16:58:55 -04:00
Pierre Vanduynslager 3daf78081f Merge branch 'master' into beta 2019-10-29 11:57:31 -04:00
Pierre Vanduynslager 9f2ec79d67 docs: limit list of suggested tools for commit linting 2019-10-09 16:42:52 -04:00
Pierre Vanduynslager 2769a5057d docs: add links to workflow configuration 2019-09-26 14:48:54 -07:00
Pierre Vanduynslager f5737c821b Merge branch 'master' into beta 2019-09-13 17:08:48 -04:00
Pierre Vanduynslager 7ddc2cfcbc docs: update table of content in README.md and in Gitbook SUMMARY.md 2019-08-22 14:47:21 -04:00
Pierre Vanduynslager 54d8e3fe99 revert: docs: note publishing on distribution channels in beta
This reverts commit 490d86d0d5.
2019-08-22 14:47:21 -04:00
Pierre Vanduynslager e770c50f01 revert: docs: synched README.md and SUMMARY.md
This reverts commit 813e5f65ed.
2019-08-22 14:47:21 -04:00
Pierre Vanduynslager 5e41dc89bd revert: docs: made doc file org clearer and augmented content
This reverts commit 5a5eaec3da.
2019-08-22 14:47:21 -04:00
Pierre Vanduynslager ce3d1bc715 revert: docs: corrections and further clarifications
This reverts commit 7cb5446bb5.
2019-08-22 14:47:21 -04:00
Emmanuel Sciara 7cb5446bb5 docs: corrections and further clarifications
- (correction) removed comments from code samples.
-(correction) remove recommendation for global
install on CI environemnts.
- Synched README.md and SUMMARY.md
2019-07-31 14:40:10 -07: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 813e5f65ed docs: synched README.md and SUMMARY.md 2019-07-30 16:13:59 -07:00
scott willeke 490d86d0d5 docs: note publishing on distribution channels in beta
Since the readme hints at doing this, note that features to automate this are in beta. Also discussed at https://spectrum.chat/semantic-release/general/im-trying-to-configure-a-next-release~5bb8e692-a0cd-49be-8379-9fb6b25261fe
2019-07-21 19:03:45 -07:00
Jan Piotrowski d034ce5249 docs: Remove broken waffle.io 💀 badge 2019-05-20 14:08:48 -07:00
Ben Hutton 61762e67a0 docs: update commitlint URL
The current commitlint URL goes to a repo which contains a redirect message and new URL.
Replace the outdated URL with the new URL for the commitlint repo.
2019-04-15 11:19:51 -04:00
Pierre Vanduynslager 0d91027e9f docs: update release triggering section in README 2018-12-31 03:35:32 -05:00
Pierre Vanduynslager 2144f2064f docs: add missing recipes link in README 2018-12-31 03:35:32 -05:00
Pierre Vanduynslager 635406c4c8 docs: switch to spectrum.chat 2018-12-11 21:18:39 -05:00
Pierre Vanduynslager 6b110b6e9e docs: switch to spectrum.chat 2018-12-03 17:48:15 -05:00
Pierre Vanduynslager 7b4052470b feat: support multiple branches and distribution channels
- Allow to configure multiple branches to release from
- Allow to define a distribution channel associated with each branch
- Manage the availability on distribution channels based on git merges
- Support regular releases, maintenance releases and pre-releases
- Add the `addChannel` plugin step to make an existing release available on a different distribution channel

BREAKING CHANGE: the `branch` option has been removed in favor of `branches`

The new `branches` option expect either an Array or a single branch definition. To migrate your configuration:
- If you want to publish package from multiple branches, please the configuration documentation
- If you use the default configuration and want to publish only from `master`: nothing to change
- If you use the `branch` configuration and want to publish only from one branch: replace `branch` by `branches` (`"branch": "my-release-branch"` => `"branches": "my-release-branch"`)
2018-11-29 14:13:03 -05:00