Skip to content

Add valid release examples to releases documentation #14514

@JoshFerge

Description

@JoshFerge

Which part? Which one?

Improve Release Semver documentation

Description

On our releases pages, we give a grammar of what a valid release is, but don't give concrete examples of various values that users can set.

Suggested Solution

It would be nice if we could include these values:

  - Examples of valid Semver releases:
      "package@1",  # Major version only
      "[email protected]",  # Major and minor version
      "[email protected]",  # Major, minor, and patch version
      "[email protected]",  # With prerelease
      "[email protected]",  # With prerelease and number
      "[email protected]",  # With prerelease and text
      "[email protected]+43",  # With prerelease and build
      "package@1-alpha+43",  # major only with prerelease and build
      "[email protected]+whatever",  # With build metadata
      "[email protected]",  # Four version components with revision (major.minor.patch.revision)
      "[email protected]",  # pre-release
      "[email protected]+exp.sha.5114f85",  # pre-release and build
      "[email protected]+20130313144700",  # version and build
      "[email protected]",  # Prerelease starting with number
      "[email protected]+exp.sha.5114f85",  # major, minor, patch, revision, pre-release, and build

They would go here, for example: https://docs.sentry.io/platforms/javascript/guides/astro/configuration/releases/#bind-the-version

after the last Semantic bullet, still under the Semantic bullet list. There are a bunch of release.mdx files where we need to insert these and make sure it's formatted correctly and looks good.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions