Skip to content

Commit 76fb990

Browse files
committed
Updated README_Development.md (links)
1 parent 0195b9b commit 76fb990

1 file changed

Lines changed: 18 additions & 10 deletions

File tree

README_Development.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,10 @@ This repository contains basic portions of the restructured ***Investigative Gen
1414
* [Directory Structure](#directory-structure)
1515
* [Solution Structure](#solution-structure)
1616
* [The IGLibCore and Other Base Modules](#the-iglibcore-and-other-base-modules)
17-
* [To Do](#things-to-be-done)
18-
* [Versioning IHLib Modules]()
17+
* [CI/CD]()
18+
* [Versioning IGLib Modules](#versioning-iglib-modules)
19+
* See also the [Versioning document on Wiki](https://github.com/ajgorhoe/wiki.IGLib/blob/main/IGLib/general/CiCd/Versioning.md) (*private repo*!)
20+
* **[To Do](#things-to-be-done)**
1921

2022
## Instructions for Developers
2123

@@ -97,18 +99,22 @@ Division of modules into
9799
* Should **avoid dependcncies on NuGet packages** and should **only have dependencies on .NET base libraries**.
98100
* Should **avoid dependencies on complex .NET stuff** and stuff that is likely subject to changes (based on past experience) **such as serialization**.
99101

102+
## IGLib CI/CD
103+
104+
We currently use Github Actions for Continuous integration. [GitVersion](#versioning-iglib-modules) is used to automatize versioning.
105+
100106
### Versioning IGLib Modules
101107

102-
**See also** the [Versioning document o Wiki](https://github.com/ajgorhoe/wiki.IGLib/blob/main/IGLib/general/CiCd/Versioning.md) (private repo!)
108+
**See also** the [Versioning document on Wiki](https://github.com/ajgorhoe/wiki.IGLib/blob/main/IGLib/general/CiCd/Versioning.md) (*private repo*!)
103109

104110
In this context, IGLib Module means a set of projects contained in a single repository.
105111

106-
We use **`[GitVersion](https://gitversion.net/docs/usage/msbuild)`** for versioning. This is done by including the following in .NET project files (.csproj):
112+
We use **[GitVersion](https://gitversion.net/docs/usage/msbuild)** for versioning. This is done by including the following in .NET project files (.csproj):
107113

108114
~~~xml
109-
<ItemGroup>
110-
<PackageReference Include="GitVersion.MsBuild" Version="*" PrivateAssets="All" />
111-
</ItemGroup>
115+
<ItemGroup>
116+
<PackageReference Include="GitVersion.MsBuild" Version="*" PrivateAssets="All" />
117+
</ItemGroup>
112118
~~~
113119

114120
The attribute `<PrivateAssets>all</PrivateAssets>` prevents the task from becoming a dependency of the package we build.
@@ -225,13 +231,15 @@ git tag -a v1.2.3 -m "Version 1.2.3"
225231
git push origin v1.2.3
226232
~~~
227233

228-
229-
230234
**Example Workflow**:
231235

232236
* tag the last verison on the `main` branch
233237
* branch off `develop` and other branches like `feature` or `release` branches; they will be versioned according to rules specified in basic configuration plus additional configuration (e.g. `GitVersion.yml` in the repository root)
234238
* when merging back to the `main` branch, tag the main branch with the version calculated by the GitVersion tool
235239
* start again from the second pooint
236240

237-
241+
242+
243+
## Things to Be Done
244+
245+
This section contains unarranged quick notes on what needs to be done.

0 commit comments

Comments
 (0)