File tree Expand file tree Collapse file tree 1 file changed +27
-0
lines changed
Expand file tree Collapse file tree 1 file changed +27
-0
lines changed Original file line number Diff line number Diff line change @@ -136,3 +136,30 @@ To test performance it's best to build the binary and run outside of docker:
136136
137137For reference here's the `markitpy-doc` docset (50k markdown files) currently takes `14s` vs `several minutes` compared to
138138existing surveyed tools
139+
140+ # Release Process
141+
142+ This section outlines the process for releasing a new version of this project.
143+
144+ # # Versioning
145+
146+ This project uses [Semantic Versioning](https://semver.org/) and its version is
147+ automatically determined by [release-drafter](https://github.com/release-drafter/release-drafter)
148+ based on the labels of the pull requests merged into the `main` branch.
149+
150+ See the [release-drafter configuration](../.github/release-drafter.yml) for more details.
151+
152+ # # Creating a New Release
153+
154+ Every time a pull request is merged into the `main` branch, release-drafter will
155+ create a draft release or update the existing draft release in the [Releases](https://github.com/elastic/docs-builder/releases) page.
156+
157+ To create a new release you need to publish the existing draft release created by release-drafter.
158+
159+ > [!IMPORTANT]
160+ > Make sure the [release-drafter workflow](../.github/workflows/release-drafter.yml) is finished before publishing the release.
161+
162+ > [!NOTE]
163+ > When a release is published, the [create-major-tag workflow](../.github/workflows/create-major-tag.yml)
164+ > will force push a new major tag in the format `vX` where `X` is the major version of the release.
165+ > For example, if the release is `v1.2.3` was published, the workflow will force push a new tag `v1` on the same commit.
You can’t perform that action at this time.
0 commit comments