Skip to content

Commit

Permalink
Added versioning info to the Readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
ykuijs committed Mar 28, 2024
1 parent 724bab0 commit 76551d5
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 1 deletion.
1 change: 1 addition & 0 deletions .github/workflows/ModuleBuildTestRelease.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ on:
- main
paths-ignore:
- CHANGELOG.md
- README.md
tags:
- v*
#tags-ignore:
Expand Down
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,26 @@
# M365DSC.CompositeResources

This module contains various Composite Resources for Microsoft365DSC, which can be used with Microsoft365DSC deployments. Each workload has its own Composite Resource.
This module contains various Composite Resources for [Microsoft365DSC](https://microsoft365dsc.com/), which can be used with Microsoft365DSC deployments. Each workload has its own Composite Resource.
The module is generated based on a specific version of Microsoft365DSC and has to be used in combination with that version.

These Composite Resources are also used in the Microsoft365DSC whitepaper ["Managing Microsoft 365 in true DevOps style with Microsoft365DSC and Azure DevOps"](https://aka.ms/m365dscwhitepaper).

## Version numbering

This module is matching the version numbering of Microsoft365DSC, with one difference. Microsoft365DSC is using the following format: **1.aa.bcc.d** where
- aa: The year
- b : The month, one or two digits depending on the month
- cc: The day, always written in two digits
- d : Release counter for the releases of that week

For example:
- 1.24.313.1: The first release of the week of Wednesday March 13th, 2024
- 1.24.1003.2: The second release of the week of October 3rd, 2024

### M365DSC.CompositeResources

For the version number of M365DSC.CompositeResource, we are adding a counter of two digits (starting at zero) to the end of the release counter.

For example:
- For Microsoft365DSC v1.24.313.1, the first release of M365DSC.CompositeResources will be 1.24.313.100.
- For Microsoft365DSC v1.24.1003.2, the second release of M365DSC.CompositeResources will be 1.24.1003.201.

0 comments on commit 76551d5

Please sign in to comment.