Skip to content

Commit e16df69

Browse files
fgildefgilde
committed
Merge branch 'master' of https://github.com/fgilde/UNLowCoder 
2 parents feb47dc + 7d7c167 commit e16df69

15 files changed

Lines changed: 182 additions & 0 deletions

File tree

‎.github/workflows/documentation.yml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
concurrency:
15+
group: "pages"
16+
cancel-in-progress: false
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- name: Checkout
23+
uses: actions/checkout@v4
24+
25+
- name: Setup .NET
26+
uses: actions/setup-dotnet@v4
27+
with:
28+
dotnet-version: '9.0.x'
29+
30+
- name: Install DocFX
31+
run: dotnet tool install -g docfx --version 2.77.0
32+
33+
- name: Restore dependencies
34+
run: dotnet restore
35+
36+
- name: Build projects
37+
run: |
38+
dotnet build UNLowCoder/UNLowCoder.Core.csproj --configuration Release --no-restore
39+
dotnet build UNLowCoder.SourceGen/UNLowCoder.SourceGen.csproj --configuration Release --no-restore
40+
dotnet build UNLowCoder.Extensions/UNLowCoder.Extensions.csproj --configuration Release --no-restore
41+
dotnet build UNLowCoder.Lib/UNLowCoder.Lib.csproj --configuration Release --no-restore
42+
43+
- name: Build documentation
44+
run: docfx docs/docfx.json
45+
46+
- name: Upload artifact
47+
uses: actions/upload-pages-artifact@v3
48+
with:
49+
path: docs/_site
50+
51+
deploy:
52+
environment:
53+
name: github-pages
54+
url: ${{ steps.deployment.outputs.page_url }}
55+
runs-on: ubuntu-latest
56+
needs: build
57+
steps:
58+
- name: Deploy to GitHub Pages
59+
id: deployment
60+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -362,3 +362,8 @@ MigrationBackup/
362362
# Fody - auto-generated XML schema
363363
FodyWeavers.xsd
364364
/UNLowCoder.Lib/GeneratedFiles/
365+
366+
# DocFX generated documentation
367+
docs/_site/
368+
docs/api/
369+
docs/obj/

‎README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ The code list is updated and published by the UNECE every quarter. The code list
55
This project provides functionality to parse the CSV file at runtime and also source generators to generate C# classes for the UN/Locodes.
66
And a generated class library to easially use the UN/Locodes in your project.
77

8+
## 📚 Documentation
9+
View the complete API documentation at: **[https://fgilde.github.io/UNLowCoder](https://fgilde.github.io/UNLowCoder)**
10+
811
## UNLowCoder.Core
912
[![NuGet](https://img.shields.io/nuget/v/UNLowCoder.Core)](https://www.nuget.org/packages/UNLowCoder.Core/)
1013
<br>

‎UNLowCoder.Extensions/README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
This package contains the extended functionality for the UNLocode Contracts and lists from
55
[UNLowCoder.Core](https://www.nuget.org/packages/UNLowCoder.Core/) .
66

7+
## 📚 Documentation
8+
View the complete API documentation at: **[https://fgilde.github.io/UNLowCoder](https://fgilde.github.io/UNLowCoder)**
9+
710

811
## Usage
912

‎UNLowCoder.Extensions/UNLowCoder.Extensions.csproj‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
<TargetFramework>netstandard2.0</TargetFramework>
66
<LangVersion>latest</LangVersion>
77
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
8+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
89
</PropertyGroup>
910

1011
<PropertyGroup>

‎UNLowCoder.Lib/README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
This package contains the core functionality to parse the UNLocode csv files and provides generated classes under the namespace `UnLocodes`.
55
It uses the [UNLowCoder.SourceGen](https://www.nuget.org/packages/UNLowCoder.SourceGen/) package to generate the resulting classes.
66

7+
## 📚 Documentation
8+
View the complete API documentation at: **[https://fgilde.github.io/UNLowCoder](https://fgilde.github.io/UNLowCoder)**
9+
710

811
## Usage
912

‎UNLowCoder.Lib/UNLowCoder.Lib.csproj‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
<!--<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>-->
1010
<CompilerGeneratedFilesOutputPath>GeneratedFiles</CompilerGeneratedFilesOutputPath>
1111
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
12+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
1213
</PropertyGroup>
1314

1415
<PropertyGroup>

‎UNLowCoder.SourceGen/README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ Implemented via [C# source generators](https://docs.microsoft.com/en-us/dotnet/c
1212

1313
Also this package is used by [UNLowCoder.Lib](https://www.nuget.org/packages/UNLowCoder.Lib/) that provides the generated classes for the UNLocode csv files.
1414

15+
## 📚 Documentation
16+
View the complete API documentation at: **[https://fgilde.github.io/UNLowCoder](https://fgilde.github.io/UNLowCoder)**
17+
1518

1619
## Usage
1720

‎UNLowCoder.SourceGen/UNLowCoder.SourceGen.csproj‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
<IsPackable>true</IsPackable>
2020
<!--<IncludeBuildOutput>false</IncludeBuildOutput>-->
2121
<DevelopmentDependency>true</DevelopmentDependency>
22+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
2223
</PropertyGroup>
2324

2425
<PropertyGroup>

‎UNLowCoder/README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ package to provide and generate the classes for UN/Locodes.
88
<br>
99
But you can use the Core package also standalone to parse the csv zip files own your own at runtime.
1010

11+
## 📚 Documentation
12+
View the complete API documentation at: **[https://fgilde.github.io/UNLowCoder](https://fgilde.github.io/UNLowCoder)**
13+
1114
## Usage
1215

1316
### Install the nuget package

0 commit comments

Comments
 (0)