Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
basil committed Apr 12, 2024
1 parent a356968 commit 1ff52fe
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions content/doc/developer/publishing/releasing-cd.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ Be sure to apply one of the link:https://github.com/jenkinsci/.github/blob/ce466
to this and every subsequent PR before merging so that Release Drafter can properly categorize changes.

Fully automated versioning (recommended)::
For a regular component whose version number is not that meaningful, let the version number be automatically determined by setting a top-level `<version>+++${changelist}+++</version>` and having an entry `<changelist>999999-SNAPSHOT</changelist>` in the `<properties>` section, removing `<revision>`:
For a regular component whose version number is not that meaningful, let the version number be automatically determined by setting a top-level `<version>+++${changelist}+++</version>` and having an entry `<changelist>999999-SNAPSHOT</changelist>` in the `<properties>` section, removing `<revision>` and `<project.build.outputTimestamp>` (if present):
+
[source,diff]
----
Expand All @@ -148,6 +148,7 @@ For a regular component whose version number is not that meaningful, let the ver
- <changelist>-SNAPSHOT</changelist>
+ <changelist>999999-SNAPSHOT</changelist>
<jenkins.version>2.361.4</jenkins.version>
- <project.build.outputTimestamp>2023-01-01T00:00:00Z</project.build.outputTimestamp>
</properties>
----
+
Expand All @@ -168,7 +169,7 @@ NOTE: It is worth communicating this to your users, as they will see a very diff
The best way to do this is to add a line to the release notes: link:https://github.com/jenkinsci/azure-artifact-manager-plugin/releases/tag/86.va2aa4b1038c7[example note].

Manually controlled prefix (optional)::
If you do not want to have large major version numbers, like with fully automated versioning described above, keep `<revision>` in the `<properties>` section, setting it to the prefix (`major`, `major.minor`, etc., depending on how much of the version number you want to manually manage) and use it as part of the top-level `<version>` element:
If you do not want to have large major version numbers, like with fully automated versioning described above, keep `<revision>` in the `<properties>` section, setting it to the prefix (`major`, `major.minor`, etc., depending on how much of the version number you want to manually manage) and use it as part of the top-level `<version>` element, removing `<project.build.outputTimestamp>` (if present):
+
[source,diff]
----
Expand All @@ -191,6 +192,7 @@ If you do not want to have large major version numbers, like with fully automate
+ <revision>1</revision>
+ <changelist>999999-SNAPSHOT</changelist>
<jenkins.version>2.361.4</jenkins.version>
- <project.build.outputTimestamp>2023-01-01T00:00:00Z</project.build.outputTimestamp>
----
+
Here the version numbers will look like `1.321.vabcdef456789` or `1.999999-SNAPSHOT`, respectively.
Expand All @@ -202,7 +204,7 @@ IMPORTANT: It is _not recommended_ to implement actual semantic versioning with
Otherwise, automated releases may have version numbers that semantically would not make sense.

Versioning with wrapped components (optional)::
Similar to the previous option, for a component whose version number ought to reflect a release version of some wrapped component, use a hyphen (`-`) as the separator between the prefix corresponding to the wrapped component's version and the CD-generated suffix:
Similar to the previous option, for a component whose version number ought to reflect a release version of some wrapped component, use a hyphen (`-`) as the separator between the prefix corresponding to the wrapped component's version and the CD-generated suffix, removing `<project.build.outputTimestamp>` (if present):
+
[source,diff]
----
Expand All @@ -225,6 +227,7 @@ Similar to the previous option, for a component whose version number ought to re
+ <revision>4.0.0</revision>
+ <changelist>999999-SNAPSHOT</changelist>
<jenkins.version>2.361.4</jenkins.version>
- <project.build.outputTimestamp>2023-01-01T00:00:00Z</project.build.outputTimestamp>
----
+
Here the version numbers will look like `4.0.0-123.vabcdef456789` or `4.0.0-999999-SNAPSHOT`, respectively.
Expand Down

0 comments on commit 1ff52fe

Please sign in to comment.