From 85e4b556a81e705939a6af40265bc68e7c5a0dcd Mon Sep 17 00:00:00 2001 From: Matt Travi Date: Fri, 19 Apr 2024 16:25:01 -0500 Subject: [PATCH] docs(release-workflows): reworded some details about the release workflow docs for clarity --- SUMMARY.md | 2 +- docs/usage/workflow-configuration.md | 13 +++++++------ 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/SUMMARY.md b/SUMMARY.md index 2a463bf9a2..e8a7729fcb 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -7,7 +7,7 @@ - [CI Configuration](docs/usage/ci-configuration.md) - [Configuration](docs/usage/configuration.md) - [Plugins](docs/usage/plugins.md) -- [Workflow configuration](docs/usage/workflow-configuration.md) +- [Release Workflow configuration](docs/usage/workflow-configuration.md) - [Shareable configurations](docs/usage/shareable-configurations.md) ## Extending diff --git a/docs/usage/workflow-configuration.md b/docs/usage/workflow-configuration.md index ef14c02ba0..bec2be2be6 100644 --- a/docs/usage/workflow-configuration.md +++ b/docs/usage/workflow-configuration.md @@ -1,11 +1,12 @@ -# Workflow configuration +# Release Workflow configuration -**semantic-release** allow to manage and automate complex release workflow, based on multiple Git branches and distribution channels. This allow to: +**semantic-release** enables managing and automating complex release workflow, based on multiple Git branches and distribution channels. +This enables: -- Distribute certain releases to a particular group of users via distribution channels -- Manage the availability of releases on distribution channels via branches merge -- Maintain multiple lines of releases in parallel -- Work on large future releases outside the normal flow of one version increment per Git push +- Distributing certain releases to a particular group of users via distribution channels +- Managing the availability of releases on distribution channels via branches merge +- Maintaining multiple lines of releases in parallel +- Working on large future releases outside the normal flow of one version increment per Git push See [Release workflow recipes](../recipes/release-workflow/README.md#release-workflow) for detailed examples.