You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
Copy file name to clipboardExpand all lines: src/pages/docs/packaging-applications/create-packages/versioning.md
+23-23Lines changed: 23 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,16 +19,16 @@ Consider the following factors when deciding on the versioning scheme you'll use
19
19
20
20
1. Can you trace a version back to the commit/check-in the application/package was built from?
21
21
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.*
23
23
24
24
2. Can your users easily report a version to the development team that supports #1?
25
25
3. Will your version numbers be confusing, or will they help people understand the changes that have been made to the software?
26
26
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.*
28
28
29
29
4. Does your tool chain support the versioning scheme?
30
30
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).*
32
32
33
33
## SemVer {#semver}
34
34
@@ -72,7 +72,7 @@ Octopus uses a string-based approach to version numbers. These are the decisions
72
72
i. `3.0.0-beta.10 > 3.0.0-beta.9`
73
73
i. `1.4.008 < 1.4.9`
74
74
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.
76
76
77
77
## Maven versions {#maven}
78
78
@@ -82,23 +82,23 @@ The Maven versioning scheme is implemented as a copy of the [ComparableVersion](
82
82
83
83
Maven version strings have 5 parts:
84
84
85
-
* Major
86
-
* Minor
87
-
* Patch
88
-
* Build number
89
-
* Qualifier
85
+
- Major
86
+
- Minor
87
+
- Patch
88
+
- Build number
89
+
- Qualifier
90
90
91
91
The Major, Minor, Patch, and Build number are all integer values.
92
92
93
93
The Qualifier can hold any value, although some qualifiers have special meanings and an associated order of precedence as follows:
94
94
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
102
102
103
103
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.
104
104
@@ -110,10 +110,10 @@ For an in-depth look at Maven versions, see the blog post [Maven Versions Explai
110
110
111
111
## Learn more
112
112
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).
0 commit comments