Skip to content

Commit 7637a7a

Browse files
NickJosevskiclaude
andcommitted
Fix pre-existing markdownlint violations in versioning.md
CI runs markdownlint-cli2 only on files changed by the PR, so the prior commit's single-sentence addition to versioning.md surfaced 23 long- standing violations in the same file that had been latent on main. Fixed mechanically: - MD029 (ordered-list prefix): continuation paragraphs under list items 1, 3, 4 were indented 2 spaces instead of 3, breaking them out of the list and making each subsequent item look like a fresh "1." Indented to 3 spaces so the list stays connected. - MD005 (list-indent): item " 3." in the "How Octopus Deploy treats semantic versions" list had a stray leading space. - MD004 (ul-style): two unordered lists under "Maven versions" used `*` bullets; the repo style is `-`. - MD007 (ul-indent): "Learn more" list items were indented one space; should be column 0. No content changes. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 6d48063 commit 7637a7a

1 file changed

Lines changed: 23 additions & 23 deletions

File tree

  • src/pages/docs/packaging-applications/create-packages

src/pages/docs/packaging-applications/create-packages/versioning.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,16 @@ Consider the following factors when deciding on the versioning scheme you'll use
1919

2020
1. Can you trace a version back to the commit/check-in the application/package was built from?
2121

22-
*For example: We stamp the SHA hash of the git commit into the metadata component of the Semantic Version for Octopus Deploy which makes it easier to find and fix bugs. We also tag the commit with the version of Octopus Deploy it produced so you can quickly determine which commit produced a particular version of Octopus Deploy.*
22+
*For example: We stamp the SHA hash of the git commit into the metadata component of the Semantic Version for Octopus Deploy which makes it easier to find and fix bugs. We also tag the commit with the version of Octopus Deploy it produced so you can quickly determine which commit produced a particular version of Octopus Deploy.*
2323

2424
2. Can your users easily report a version to the development team that supports #1?
2525
3. Will your version numbers be confusing, or will they help people understand the changes that have been made to the software?
2626

27-
*For example: bumping a major version component (first part) means there are potentially breaking changes, but bumping a patch (3rd part) should be safe to upgrade, and safe to rollback if something goes wrong.*
27+
*For example: bumping a major version component (first part) means there are potentially breaking changes, but bumping a patch (3rd part) should be safe to upgrade, and safe to rollback if something goes wrong.*
2828

2929
4. Does your tool chain support the versioning scheme?
3030

31-
*Octopus supports Semantic Versioning, which enables enhanced features like [Channels](/docs/releases/channels).*
31+
*Octopus supports Semantic Versioning, which enables enhanced features like [Channels](/docs/releases/channels).*
3232

3333
## SemVer {#semver}
3434

@@ -72,7 +72,7 @@ Octopus uses a string-based approach to version numbers. These are the decisions
7272
i. `3.0.0-beta.10 > 3.0.0-beta.9`
7373
i. `1.4.008 < 1.4.9`
7474

75-
3. **Package Feeds:** Octopus asks the feed for a package with the version string stored in the release, and accepts what the feed provides.
75+
3. **Package Feeds:** Octopus asks the feed for a package with the version string stored in the release, and accepts what the feed provides.
7676

7777
## Maven versions {#maven}
7878

@@ -82,23 +82,23 @@ The Maven versioning scheme is implemented as a copy of the [ComparableVersion](
8282

8383
Maven version strings have 5 parts:
8484

85-
* Major
86-
* Minor
87-
* Patch
88-
* Build number
89-
* Qualifier
85+
- Major
86+
- Minor
87+
- Patch
88+
- Build number
89+
- Qualifier
9090

9191
The Major, Minor, Patch, and Build number are all integer values.
9292

9393
The Qualifier can hold any value, although some qualifiers have special meanings and an associated order of precedence as follows:
9494

95-
* alpha or a
96-
* beta or b
97-
* milestone or m
98-
* rc or cr
99-
* snapshot
100-
* (the empty string) or ga or final
101-
* sp
95+
- alpha or a
96+
- beta or b
97+
- milestone or m
98+
- rc or cr
99+
- snapshot
100+
- (the empty string) or ga or final
101+
- sp
102102

103103
Qualifiers are case-insensitive, and some of the qualifiers have shorthand aliases, for instance, `alpha` and `a`. If you use an alias it must include a number, for instance, `a1`. If you do not include a number after the alias, it will be treated as an unrecognized qualifier which will be compared as a case-insensitive string after the qualified versions.
104104

@@ -110,10 +110,10 @@ For an in-depth look at Maven versions, see the blog post [Maven Versions Explai
110110

111111
## Learn more
112112

113-
- [Package your applications](/docs/packaging-applications).
114-
- [Create packages with Octopus CLI](/docs/packaging-applications/create-packages/octopus-cli).
115-
- [Creating packages with OctoPack](/docs/packaging-applications/create-packages/octopack).
116-
- [TeamCity plugin](/docs/packaging-applications/build-servers/teamcity).
117-
- [Azure DevOps plugin](/docs/packaging-applications/build-servers/tfs-azure-devops/using-octopus-extension).
118-
- [Package repositories](/docs/packaging-applications).
119-
- [Package deployments](/docs/deployments/packages).
113+
- [Package your applications](/docs/packaging-applications).
114+
- [Create packages with Octopus CLI](/docs/packaging-applications/create-packages/octopus-cli).
115+
- [Creating packages with OctoPack](/docs/packaging-applications/create-packages/octopack).
116+
- [TeamCity plugin](/docs/packaging-applications/build-servers/teamcity).
117+
- [Azure DevOps plugin](/docs/packaging-applications/build-servers/tfs-azure-devops/using-octopus-extension).
118+
- [Package repositories](/docs/packaging-applications).
119+
- [Package deployments](/docs/deployments/packages).

0 commit comments

Comments
 (0)