Skip to content

Commit d2f1039

Browse files
committed
wording consistency
1 parent 766aea1 commit d2f1039

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

develop-docs/sdk/processes/releases.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -157,16 +157,16 @@ Specifically, craft expects versions following this format:
157157
<major>.<minor>.<patch>(-<prerelease>)?(-<build>)?
158158
```
159159

160-
While the major, minor and patch versions are required, prerelease and build properties are optional but can also be combined.
160+
While the major, minor and patch version numbers are required, pre-release and build properties are optional but can also be combined.
161161

162-
### Prereleases (`<prerelease>`)
162+
### Pre-releases (`<prerelease>`)
163163

164-
If you want to create a preview release of your SDK, you can append a prerelease identifier, as well as an optional incremental prerelease number to your version.
165-
This will ensure that various Craft publishing targets will treat the release as a prerelease, meaning for example that it will not get assigned a `latest` in package repositories.
166-
Likewise, prereleases will not be inserted into our internal release-registry, which is used by the Sentry product as well as our docs and other tools to query the latest or specific releases of our packages.
164+
If you want to create a preview or pre-release of your SDK, you can append a pre-release identifier, as well as an optional incremental pre-release number to your version.
165+
This will ensure that various craft publishing targets will treat the release as a pre-release, meaning for example that it will not get assigned a `latest` tag in package repositories.
166+
Likewise, pre-releases will not be inserted into our internal release-registry, which is used by the Sentry product as well as our docs and other tools to query the latest or specific releases of our packages.
167167

168-
However, we have strict rules around which identifiers we accept as a prerelease. Therefore, the `<prerelease>` part of your version has to be one of the following: `preview|pre|rc|dev|alpha|beta|unstable|a|b`
169-
As a consequence, we **do not accept** arbitrary strings as prerelease identifiers. Using any other identifiers will result in a release being considered stable instead.
168+
Importantly, we have strict rules around which identifiers we accept as a pre-release, meaning the `<prerelease>` part of your version has to be one of the following: `preview|pre|rc|dev|alpha|beta|unstable|a|b`.
169+
Therefore, we **do not accept** arbitrary strings as pre-release identifiers. Using any other identifiers will result in a release being considered stable instead. This means, it will get assigned a `latest` tag in package repositories and inserted into our release-registry.
170170

171171
Examples:
172172

@@ -185,13 +185,13 @@ Examples:
185185

186186
#### Special Case: Post Releases
187187

188-
Python has the concept of post releases, which Craft handles implicitly. A post release is indicated by a `-\d+` suffix to the semver version, for example: `1.0.0-1`.
189-
Given that we only consider certain identifiers as [valid prerelease identifiers](#prereleases-prerelease), post releases are considered stable releases.
188+
Python has the concept of post releases, which craft handles implicitly. A post release is indicated by a `-\d+` suffix to the semver version, for example: `1.0.0-1`.
189+
Given that we only consider certain identifiers as [valid pre-release identifiers](#pre-releases-prerelease), post releases are considered stable releases.
190190

191191
### Build identifiers (`<build>`)
192192

193193
In some cases, you can append a build identifier to your version, for example if you release the same package version for different platforms or architectures.
194-
You can also combine build and prerelease identifiers but in this case, the prerelease identifier has to come first.
194+
You can also combine build and pre-release identifiers but in this case, the pre-release identifier has to come first.
195195

196196
Examples:
197197

0 commit comments

Comments
 (0)