Skip to content

Commit 000b4ec

Browse files
committed
update versioning scheme
1 parent 280ec73 commit 000b4ec

File tree

4 files changed

+55
-137
lines changed

4 files changed

+55
-137
lines changed

MyApp/_includes/versioning-scheme.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
All ServiceStack packages are published together in "lockstep" with the same version number so the effort to upgrade ServiceStack projects can be done all at same time, with low frequency.
2+
3+
ServiceStack Versions adopt the following 3-part versioning scheme:
4+
5+
```
6+
{MAJOR}.{MINOR}.{PATCH}
7+
```
8+
9+
### Major versions
10+
11+
The `{MAJOR}` is reserved for Major releases like [v5 containing structural changes](/releases/v5_0_0) that may require changes to external environment and/or project configurations and support for different .NET Runtimes:
12+
13+
- `v5.*` - Support for .NET 5.0 and .NET Framework v4.5
14+
- `v6.*` - Support for .NET 6.0 and .NET Framework v4.7.2
15+
- `v8.*` - Support for .NET 8.0 and .NET Framework v4.7.2
16+
17+
### Minor versions
18+
19+
The `{MINOR}` version is used for major ServiceStack official releases which will have a `{PATCH}` version of **0**.
20+
21+
#### Patch versions
22+
23+
The `{PATCH}` version is used to distinguish updates from normal releases where a `{PATCH}` above **0** indicates an Enhancement Release.
24+
25+
Whilst we want to minimize the effort for Customers to upgrade we also want to make any fixes or enhancements to the
26+
previous release available sooner as there are often fixes reported and resolved immediately after each release and made
27+
available in our **pre-release NuGet packages feed** that most Customers wont get until the next major Release on NuGet.
28+
29+
To deliver updates sooner we dedicate time immediately after each release to resolving issues and adding enhancements
30+
to existing features so we can publish update releases before starting work on new major features.
31+
Update releases will be primarily additive and minimally disruptive so they're safe to upgrade.
32+
33+
- An **even** `{PATCH}` version number indicates an "Update" release published to **NuGet**.
34+
- An **odd** version number indicates a "pre-release" version that's only **available on Feedz.io** or [GitHub Packages](/gh-nuget)
35+
36+
Versioning scheme example:
37+
38+
- **v5.0.0** - Current Major Release with structural changes
39+
- v5.0.2 - Enhancement of Major v5.0.0 Release
40+
- v5.0.3 - Pre-release packages published to MyGet only
41+
- v5.0.4? - Enhancement of Major v5.0.0 Release (if any)
42+
- **v5.1.0** - Next Major Release
43+
- v5.1.1 - Pre-release packages published to MyGet only
44+
- v5.1.2? - Enhancement of Major v5.1.0 Release (if any)
45+
- ...
46+
- **v6.0.0** - Next Major Release with structural changes

MyApp/_pages/gh-nuget.md

+5-39
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ title: GitHub NuGet
66

77
Our interim pre-release NuGet packages in between major releases on NuGet are published to [GitHub](https://github.com/orgs/ServiceStack/packages).
88

9+
::: tip
10+
If preferred, the pre-release packages are also available in our [feedz.io](/pre-release) or [MyGet](/myget) package feeds.
11+
:::
12+
913

1014
### Requires GitHub Authentication
1115

@@ -189,44 +193,6 @@ delete `/bin` and `/obj` folders in host project
189193
rd /q /s bin obj
190194
:::
191195

192-
193196
## Versioning Scheme
194197

195-
All ServiceStack packages are published together in "lockstep" with the same version number so the effort to upgrade ServiceStack projects can be done all at same time, with low frequency.
196-
197-
ServiceStack Versions adopt the following 3-part versioning scheme:
198-
199-
```
200-
{MAJOR}.{MINOR}.{PATCH}
201-
```
202-
203-
### Major versions
204-
205-
The `{MAJOR}` is reserved for Major releases like [v5 containing structural changes](/releases/v5_0_0) that may require changes to external environment and/or project configurations. Major structural releases should be few and far between with currently no plans for any in the immediate future.
206-
207-
### Minor versions
208-
209-
The `{MINOR}` version is used for major ServiceStack official releases which will have a `{PATCH}` version of **0**.
210-
211-
#### Patch versions
212-
213-
The `{PATCH}` version is used to distinguish updates from normal releases where a `{PATCH}` above **0** indicates an Enhancement Release.
214-
215-
Whilst we want to minimize the effort for Customers to upgrade we also want to make any fixes or enhancements to the previous release available sooner as there are often fixes reported and resolved immediately after each release and made available in our **pre-release packages on GitHub** that most Customers wont get until the next major Release on NuGet.
216-
217-
To deliver updates sooner we dedicate time immediately after each release to resolving issues and adding enhancements to existing features so we can publish update releases before starting work on new major features. Update releases will be primarily additive and minimally disruptive so they're safe to upgrade.
218-
219-
- An **even** `{PATCH}` version number indicates an "Update" release published to **NuGet**.
220-
- An **odd** version number indicates a "pre-release" version that's only **available on GitHub**
221-
222-
Versioning scheme example:
223-
224-
- **v5.0.0** - Current Major Release with structural changes
225-
- v5.0.2 - Enhancement of Major v5.0.0 Release
226-
- v5.0.3 - Pre-release packages published to GitHub only
227-
- v5.0.4? - Enhancement of Major v5.0.0 Release (if any)
228-
- **v5.1.0** - Next Major Release
229-
- v5.1.1 - Pre-release packages published to GitHub only
230-
- v5.1.2? - Enhancement of Major v5.1.0 Release (if any)
231-
- ...
232-
- **v6.0.0** - Next Major Release with structural changes
198+
::include versioning-scheme.md::

MyApp/_pages/myget.md

+2-54
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,12 @@
22
title: MyGet
33
---
44

5-
## Pre-release packages Moved to Feedz
6-
7-
After experiencing several outages with MyGet we've decided to publish our Pre Release NuGet packages to [Feedz.io](https://feedz.io)
8-
9-
Please see the [Pre Release NuGet Packages docs](/pre-release) for configuring access to our Pre Release NuGet packages on [Feedz.io](https://feedz.io).
10-
11-
---
12-
13-
:::{.text-center .text-2xl .text-red-600 .font-medium}
14-
Old MyGet Docs
15-
:::
16-
17-
---
18-
195
## ServiceStack pre-release MyGet Feed
206

217
Our interim pre-release NuGet packages in between major releases on NuGet are published to [MyGet](https://www.myget.org/).
228

239
::: tip
24-
If preferred, the pre-release packages are also available in our [GitHub Packages Registry](/gh-nuget)
10+
If preferred, the pre-release packages are also available in our [feedz.io](/pre-release) or [GitHub Packages Registry](/gh-nuget).
2511
:::
2612

2713
### Add using Mix
@@ -108,44 +94,6 @@ delete `/bin` and `/obj` folders in host project
10894
rd /q /s bin obj
10995
:::
11096

111-
11297
## Versioning Scheme
11398

114-
All ServiceStack packages are published together in "lockstep" with the same version number so the effort to upgrade ServiceStack projects can be done all at same time, with low frequency.
115-
116-
ServiceStack Versions adopt the following 3-part versioning scheme:
117-
118-
```
119-
{MAJOR}.{MINOR}.{PATCH}
120-
```
121-
122-
### Major versions
123-
124-
The `{MAJOR}` is reserved for Major releases like [v5 containing structural changes](/releases/v5_0_0) that may require changes to external environment and/or project configurations. Major structural releases should be few and far between with currently no plans for any in the immediate future.
125-
126-
### Minor versions
127-
128-
The `{MINOR}` version is used for major ServiceStack official releases which will have a `{PATCH}` version of **0**.
129-
130-
#### Patch versions
131-
132-
The `{PATCH}` version is used to distinguish updates from normal releases where a `{PATCH}` above **0** indicates an Enhancement Release.
133-
134-
Whilst we want to minimize the effort for Customers to upgrade we also want to make any fixes or enhancements to the previous release available sooner as there are often fixes reported and resolved immediately after each release and made available in our **pre-release packages on MyGet** that most Customers wont get until the next major Release on NuGet.
135-
136-
To deliver updates sooner we dedicate time immediately after each release to resolving issues and adding enhancements to existing features so we can publish update releases before starting work on new major features. Update releases will be primarily additive and minimally disruptive so they're safe to upgrade.
137-
138-
- An **even** `{PATCH}` version number indicates an "Update" release published to **NuGet**.
139-
- An **odd** version number indicates a "pre-release" version that's only **available on MyGet**
140-
141-
Versioning scheme example:
142-
143-
- **v5.0.0** - Current Major Release with structural changes
144-
- v5.0.2 - Enhancement of Major v5.0.0 Release
145-
- v5.0.3 - Pre-release packages published to MyGet only
146-
- v5.0.4? - Enhancement of Major v5.0.0 Release (if any)
147-
- **v5.1.0** - Next Major Release
148-
- v5.1.1 - Pre-release packages published to MyGet only
149-
- v5.1.2? - Enhancement of Major v5.1.0 Release (if any)
150-
- ...
151-
- **v6.0.0** - Next Major Release with structural changes
99+
::include versioning-scheme.md::

MyApp/_pages/pre-release.md

+2-44
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: Pre Release NuGet Packages
77
Our interim pre-release NuGet packages in between major releases on NuGet are published to [Feedz.io](https://feedz.io/).
88

99
::: tip
10-
If preferred, the pre-release packages are also available in our [GitHub Packages Registry](/gh-nuget)
10+
If preferred, the pre-release packages are also available in our [MyGet](/myget) or [GitHub Packages Registry](/gh-nuget)
1111
:::
1212

1313
### Add using Mix
@@ -91,48 +91,6 @@ delete `/bin` and `/obj` folders in host project
9191
rd /q /s bin obj
9292
:::
9393

94-
9594
## Versioning Scheme
9695

97-
All ServiceStack packages are published together in "lockstep" with the same version number so the effort to upgrade ServiceStack projects can be done all at same time, with low frequency.
98-
99-
ServiceStack Versions adopt the following 3-part versioning scheme:
100-
101-
```
102-
{MAJOR}.{MINOR}.{PATCH}
103-
```
104-
105-
### Major versions
106-
107-
The `{MAJOR}` is reserved for Major releases like [v5 containing structural changes](/releases/v5_0_0) that may require changes to external environment and/or project configurations. Major structural releases should be few and far between with currently no plans for any in the immediate future.
108-
109-
### Minor versions
110-
111-
The `{MINOR}` version is used for major ServiceStack official releases which will have a `{PATCH}` version of **0**.
112-
113-
#### Patch versions
114-
115-
The `{PATCH}` version is used to distinguish updates from normal releases where a `{PATCH}` above **0** indicates an Enhancement Release.
116-
117-
Whilst we want to minimize the effort for Customers to upgrade we also want to make any fixes or enhancements to the
118-
previous release available sooner as there are often fixes reported and resolved immediately after each release and made
119-
available in our **pre-release NuGet packages feed** that most Customers wont get until the next major Release on NuGet.
120-
121-
To deliver updates sooner we dedicate time immediately after each release to resolving issues and adding enhancements
122-
to existing features so we can publish update releases before starting work on new major features.
123-
Update releases will be primarily additive and minimally disruptive so they're safe to upgrade.
124-
125-
- An **even** `{PATCH}` version number indicates an "Update" release published to **NuGet**.
126-
- An **odd** version number indicates a "pre-release" version that's only **available on Feedz.io** or [GitHub Packages](/gh-nuget)
127-
128-
Versioning scheme example:
129-
130-
- **v5.0.0** - Current Major Release with structural changes
131-
- v5.0.2 - Enhancement of Major v5.0.0 Release
132-
- v5.0.3 - Pre-release packages published to MyGet only
133-
- v5.0.4? - Enhancement of Major v5.0.0 Release (if any)
134-
- **v5.1.0** - Next Major Release
135-
- v5.1.1 - Pre-release packages published to MyGet only
136-
- v5.1.2? - Enhancement of Major v5.1.0 Release (if any)
137-
- ...
138-
- **v6.0.0** - Next Major Release with structural changes
96+
::include versioning-scheme.md::

0 commit comments

Comments
 (0)