Skip to content

Commit bc467ab

Browse files
authored
Minor enhancements (#40)
* Bump versions * Added code coverage report to PR * Test branch coverage badge * Final configuration for code coverage * readme fix
1 parent aef2c8a commit bc467ab

File tree

9 files changed

+111
-58
lines changed

9 files changed

+111
-58
lines changed

.config/dotnet-tools.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"isRoot": true,
44
"tools": {
55
"cake.tool": {
6-
"version": "3.0.0",
6+
"version": "3.1.0",
77
"commands": [
88
"dotnet-cake"
99
]

.github/workflows/build.yml

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@ name: Build
22

33
on:
44
pull_request:
5-
push:
6-
branches:
75

86
env:
97
# Set the DOTNET_SKIP_FIRST_TIME_EXPERIENCE environment variable to stop wasting time caching packages
@@ -44,35 +42,35 @@ jobs:
4442
shell: pwsh
4543
- name: Copy Coverage To Predictable Location
4644
if: github.event_name == 'pull_request'
47-
run: cp coverage/*/coverage.opencover.xml coverage/coverage.opencover.xml
45+
run: cp coverage/*/coverage.cobertura.xml coverage/coverage.cobertura.xml
4846
- name: 'Publish Code Coverage'
4947
uses: actions/upload-artifact@v2
5048
with:
51-
name: tests
52-
path: './coverage/coverage.opencover.xml'
49+
name: Coverage Cobertura Report
50+
path: './coverage/coverage.cobertura.xml'
5351
- name: 'Publish Test Results'
5452
uses: actions/upload-artifact@v2
5553
with:
56-
name: tests
54+
name: Tests HTML Report
5755
path: './coverage/VaultSharp.Extensions.Configuration.Test.html'
58-
# - name: Code Coverage Summary Report
59-
# if: github.event_name == 'pull_request'
60-
# uses: irongut/CodeCoverageSummary@v1.2.0
61-
# with:
62-
# filename: coverage/coverage.opencover.xml
63-
# badge: true
64-
# fail_below_min: true
65-
# format: markdown
66-
# hide_branch_rate: false
67-
# hide_complexity: true
68-
# indicators: true
69-
# output: both
70-
# - name: Add Coverage PR Comment
71-
# uses: marocchino/sticky-pull-request-comment@v2
72-
# if: github.event_name == 'pull_request'
73-
# with:
74-
# recreate: true
75-
# path: code-coverage-results.md
56+
- name: Code Coverage Summary Report
57+
if: github.event_name == 'pull_request'
58+
uses: irongut/CodeCoverageSummary@v1.3.0
59+
with:
60+
filename: './coverage/coverage.cobertura.xml'
61+
badge: true
62+
fail_below_min: false
63+
format: markdown
64+
hide_branch_rate: false
65+
hide_complexity: true
66+
indicators: true
67+
output: both
68+
- name: Add Coverage PR Comment
69+
uses: marocchino/sticky-pull-request-comment@v2
70+
if: github.event_name == 'pull_request'
71+
with:
72+
recreate: true
73+
path: code-coverage-results.md
7674
- name: 'Dotnet Cake Pack'
7775
run: dotnet cake --target=Pack
7876
shell: pwsh

.github/workflows/master.yml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Build Status
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
8+
env:
9+
# Set the DOTNET_SKIP_FIRST_TIME_EXPERIENCE environment variable to stop wasting time caching packages
10+
DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
11+
# Disable sending usage data to Microsoft
12+
DOTNET_CLI_TELEMETRY_OPTOUT: true
13+
# Set the build number in MinVer
14+
MINVERBUILDMETADATA: build.${{github.run_number}}
15+
16+
jobs:
17+
build:
18+
name: Build
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout
22+
uses: actions/checkout@v3
23+
with:
24+
lfs: true
25+
fetch-depth: 0
26+
- name: 'Install .NET Core SDK'
27+
uses: actions/setup-dotnet@v3
28+
with:
29+
dotnet-version: '7.0.x'
30+
- name: 'Fix permissions'
31+
run: chmod +x ./Tests/VaultSharp.Extensions.Configuration.Test/approle.sh && chmod +x ./Tests/VaultSharp.Extensions.Configuration.Test/approle_nolist.sh
32+
shell: bash
33+
- name: 'Dotnet Tool Restore'
34+
run: dotnet tool restore
35+
shell: pwsh
36+
- name: 'Dotnet Cake Build'
37+
run: dotnet cake --target=Build
38+
shell: pwsh
39+
- name: 'Dotnet Cake Test'
40+
run: dotnet cake --target=Test
41+
shell: pwsh
42+
- name: Copy Coverage To Predictable Location
43+
run: cp coverage/*/coverage.cobertura.xml coverage/coverage.cobertura.xml
44+
- name: 'Extract summary from Code Coverage Summary Report'
45+
shell: bash
46+
run: |
47+
COVERAGE=$(cat coverage/coverage.cobertura.xml | grep -oP '(?<=line-rate=")[^"]*' -m 1)
48+
COVERAGE=$(printf "%.0f\n" $(bc -l <<< "$COVERAGE*100"))
49+
echo "COVERAGE=$COVERAGE%" >> $GITHUB_ENV
50+
- name: Create the Badgegg
51+
uses: schneegans/[email protected]
52+
with:
53+
auth: ${{ secrets.GIST_SECRET }}
54+
gistID: 5242a4e2d58a428062b3a59824d5864e
55+
filename: VaultSharp.Extensions.Configuration__${{ env.BRANCH }}.json
56+
label: Coverage
57+
message: ${{ env.COVERAGE }}
58+
color: "#3fbe25"
59+
namedLogo: dotnet

LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2022 Mikhail Merkulov
3+
Copyright (c) 2023 Mikhail Merkulov
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# VaultSharp.Extensions.Configuration
22

3-
[![GitHub Actions Status](https://github.com/MrZoidberg/VaultSharp.Extensions.Configuration/workflows/Build/badge.svg?branch=master)](https://github.com/MrZoidberg/VaultSharp.Extensions.Configuration/actions) ![Nuget](https://img.shields.io/nuget/v/VaultSharp.Extensions.Configuration)
3+
[![GitHub Actions Status](https://github.com/MrZoidberg/VaultSharp.Extensions.Configuration/workflows/Build/badge.svg?branch=master)](https://github.com/MrZoidberg/VaultSharp.Extensions.Configuration/actions) ![Nuget](https://img.shields.io/nuget/v/VaultSharp.Extensions.Configuration) ![badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/MrZoidberg/5242a4e2d58a428062b3a59824d5864e/raw/VaultSharp.Extensions.Configuration__master.json)
44

55
VaultSharp.Extensions.Configuration is an extension to [VaultSharp](https://github.com/rajanadar/VaultSharp) that allows reading configuration options from Vault.
66

Source/VaultSharp.Extensions.Configuration/VaultSharp.Extensions.Configuration.csproj

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
</ItemGroup>
4848

4949
<ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.0'">
50-
<PackageReference Include="System.Text.Json" Version="7.0.2" />
50+
<PackageReference Include="System.Text.Json" Version="7.0.3" />
5151
<PackageReference Include="Microsoft.Extensions.Configuration" Version="6.0.1" />
5252
<PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="6.0.0" />
5353
<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="6.0.3" />
@@ -58,18 +58,18 @@
5858
</ItemGroup>
5959

6060
<ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.1'">
61-
<PackageReference Include="System.Text.Json" Version="7.0.2" />
61+
<PackageReference Include="System.Text.Json" Version="7.0.3" />
6262
<PackageReference Include="Microsoft.Extensions.Configuration" Version="7.0.0" />
6363
<PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="7.0.0" />
64-
<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="7.0.0" />
64+
<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="7.0.1" />
6565
<PackageReference Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="7.0.4">
6666
<PrivateAssets>all</PrivateAssets>
6767
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
6868
</PackageReference>
6969
</ItemGroup>
7070

7171
<ItemGroup Condition="'$(TargetFramework)' == 'net6.0'">
72-
<PackageReference Include="System.Text.Json" Version="7.0.2" />
72+
<PackageReference Include="System.Text.Json" Version="7.0.3" />
7373
<PackageReference Include="Microsoft.Extensions.Configuration" Version="6.0.1" />
7474
<PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="6.0.0" />
7575
<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="6.0.3" />
@@ -80,10 +80,10 @@
8080
</ItemGroup>
8181

8282
<ItemGroup Condition="'$(TargetFramework)' == 'net7.0'">
83-
<PackageReference Include="System.Text.Json" Version="7.0.2" />
83+
<PackageReference Include="System.Text.Json" Version="7.0.3" />
8484
<PackageReference Include="Microsoft.Extensions.Configuration" Version="7.0.0" />
8585
<PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="7.0.0" />
86-
<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="7.0.0" />
86+
<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="7.0.1" />
8787
<PackageReference Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="7.0.4">
8888
<PrivateAssets>all</PrivateAssets>
8989
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>

Tests/VaultSharp.Extensions.Configuration.Test/VaultSharp.Extensions.Configuration.Test.csproj

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,46 +21,46 @@
2121
</ItemGroup>
2222

2323
<ItemGroup>
24-
<PackageReference Include="Docker.DotNet" Version="3.125.14" />
25-
<PackageReference Include="FluentAssertions" Version="6.11.0" />
26-
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.5.0" />
24+
<PackageReference Include="Docker.DotNet" Version="3.125.15" />
25+
<PackageReference Include="FluentAssertions" Version="6.12.0" />
26+
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.7.2" />
2727
<PackageReference Include="Serilog.Extensions.Logging" Version="3.1.0" />
2828
<PackageReference Include="Serilog.Sinks.Console" Version="4.1.0" />
2929
<PackageReference Include="Microsoft.VisualStudio.Threading" Version="17.5.22" />
30-
<PackageReference Include="coverlet.collector" Version="3.2.0" PrivateAssets="all">
30+
<PackageReference Include="coverlet.collector" Version="6.0.0" PrivateAssets="all">
3131
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
3232
</PackageReference>
3333
<PackageReference Include="Microsoft.VisualStudio.Threading.Analyzers" Version="17.5.22">
3434
<PrivateAssets>all</PrivateAssets>
3535
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
3636
</PackageReference>
37-
<PackageReference Include="Moq" Version="4.18.4" />
37+
<PackageReference Include="Moq" Version="4.20.69" />
3838
<PackageReference Include="MinVer" Version="4.3.0">
3939
<PrivateAssets>all</PrivateAssets>
4040
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
4141
</PackageReference>
42-
<PackageReference Include="Testcontainers" Version="3.1.0" />
43-
<PackageReference Include="xunit" Version="2.4.2" />
44-
<PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
42+
<PackageReference Include="Testcontainers" Version="3.4.0" />
43+
<PackageReference Include="xunit" Version="2.5.0" />
44+
<PackageReference Include="xunit.runner.visualstudio" Version="2.5.0">
4545
<PrivateAssets>all</PrivateAssets>
4646
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
4747
</PackageReference>
4848
</ItemGroup>
4949

5050
<ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.1'">
51-
<PackageReference Include="System.Text.Json" Version="7.0.2" />
51+
<PackageReference Include="System.Text.Json" Version="7.0.3" />
5252
<PackageReference Include="Microsoft.Extensions.Configuration" Version="7.0.0" />
5353
<PackageReference Include="Microsoft.Extensions.Configuration.Binder" Version="7.0.4" />
5454
<PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="7.0.0" />
55-
<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="7.0.0" />
55+
<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="7.0.1" />
5656
<PackageReference Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="7.0.4">
5757
<PrivateAssets>all</PrivateAssets>
5858
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
5959
</PackageReference>
6060
</ItemGroup>
6161

6262
<ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.0'">
63-
<PackageReference Include="System.Text.Json" Version="7.0.2" />
63+
<PackageReference Include="System.Text.Json" Version="7.0.3" />
6464
<PackageReference Include="Microsoft.Extensions.Configuration" Version="6.0.1" />
6565
<PackageReference Include="Microsoft.Extensions.Configuration.Binder" Version="6.0.0" />
6666
<PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="6.0.0" />
@@ -72,7 +72,7 @@
7272
</ItemGroup>
7373

7474
<ItemGroup Condition="'$(TargetFramework)' == 'net6.0'">
75-
<PackageReference Include="System.Text.Json" Version="7.0.2" />
75+
<PackageReference Include="System.Text.Json" Version="7.0.3" />
7676
<PackageReference Include="Microsoft.Extensions.Configuration" Version="6.0.1" />
7777
<PackageReference Include="Microsoft.Extensions.Configuration.Binder" Version="6.0.0" />
7878
<PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="6.0.0" />
@@ -84,11 +84,11 @@
8484
</ItemGroup>
8585

8686
<ItemGroup Condition="'$(TargetFramework)' == 'net7.0'">
87-
<PackageReference Include="System.Text.Json" Version="7.0.2" />
87+
<PackageReference Include="System.Text.Json" Version="7.0.3" />
8888
<PackageReference Include="Microsoft.Extensions.Configuration" Version="7.0.0" />
8989
<PackageReference Include="Microsoft.Extensions.Configuration.Binder" Version="7.0.4" />
9090
<PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="7.0.0" />
91-
<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="7.0.0" />
91+
<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="7.0.1" />
9292
<PackageReference Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="7.0.4">
9393
<PrivateAssets>all</PrivateAssets>
9494
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>

VaultSharp.Extensions.Configuration.sln

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
Microsoft Visual Studio Solution File, Format Version 12.00
3-
# Visual Studio Version 16
4-
VisualStudioVersion = 16.0.28803.352
3+
# Visual Studio Version 17
4+
VisualStudioVersion = 17.5.33424.131
55
MinimumVisualStudioVersion = 10.0.40219.1
66
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Source", "Source", "{719809C2-A551-4C4A-9EFD-B10FB5E35BC0}"
77
ProjectSection(SolutionItems) = preProject
@@ -21,13 +21,13 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
2121
EndProject
2222
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Other Files", "Other Files", "{7EDFA103-DB69-4C88-9DE4-97ADBF8253A1}"
2323
ProjectSection(SolutionItems) = preProject
24-
LICENSE.md = LICENSE.md
25-
README.md = README.md
2624
build.cake = build.cake
2725
Directory.Build.props = Directory.Build.props
2826
Directory.Build.targets = Directory.Build.targets
2927
Gitversion.yml = Gitversion.yml
3028
Key.snk = Key.snk
29+
LICENSE.md = LICENSE.md
30+
README.md = README.md
3131
runsettings.xml = runsettings.xml
3232
EndProjectSection
3333
EndProject
@@ -67,7 +67,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "workflows", "workflows", "{
6767
.github\workflows\release-drafter.yml = .github\workflows\release-drafter.yml
6868
EndProjectSection
6969
EndProject
70-
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SampleWebApp", "Source\SampleWebApp\SampleWebApp.csproj", "{26A6804B-2A4B-4629-89DE-C5476072B4E3}"
70+
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SampleWebApp", "Source\SampleWebApp\SampleWebApp.csproj", "{26A6804B-2A4B-4629-89DE-C5476072B4E3}"
7171
EndProject
7272
Global
7373
GlobalSection(SolutionConfigurationPlatforms) = preSolution

build.cake

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,15 +48,11 @@ Task("Test")
4848
new DotNetTestSettings()
4949
{
5050
Configuration = configuration,
51-
//Logger = $"trx;LogFileName={project.GetFilenameWithoutExtension()}.trx",
51+
Loggers = new[] { "trx" },
5252
NoBuild = true,
5353
NoRestore = true,
5454
ResultsDirectory = "coverage",
55-
ArgumentCustomization = x => x
56-
.AppendSwitch("--logger", $"html;LogFileName={project.GetFilenameWithoutExtension()}.html")
57-
.Append("--collect:\"XPlat Code Coverage\"")
58-
//.Append("--results-directory coverage")
59-
.Append("--settings runsettings.xml"),
55+
Collectors = new[] { "XPlat Code Coverage;Format=cobertura" },
6056
});
6157
});
6258

0 commit comments

Comments
 (0)