Skip to content

Commit f9658e7

Browse files
dsymesergey-tihon
dsyme
and
sergey-tihon
authored
Generate docs (#368)
* fix build * fix build * fix: ci dotnet version * fix warnings * fix tests * update fake stuff * fix tests * fix tests * fix logo * include IVT * fix packing * updates * update build * update build Co-authored-by: Sergey Tihon <sergey.tihon@gmail.com>
1 parent c052960 commit f9658e7

File tree

13 files changed

+86
-30
lines changed

13 files changed

+86
-30
lines changed

‎.config/dotnet-tools.json

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,18 @@
77
"commands": [
88
"paket"
99
]
10-
},
10+
},
1111
"fake-cli": {
1212
"version": "5.20.4",
1313
"commands": [
1414
"fake"
1515
]
16+
},
17+
"fsharp.formatting.commandtool": {
18+
"version": "11.4.3",
19+
"commands": [
20+
"fsdocs"
21+
]
1622
}
1723
}
1824
}

‎.github/workflows/main.yml renamed to ‎.github/workflows/pr.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
name: Build and Test
22

33
on:
4-
push:
5-
branches:
6-
- master
74
pull_request:
85
branches:
96
- master

‎.github/workflows/push.yml

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Build and Test
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
8+
jobs:
9+
build:
10+
11+
strategy:
12+
fail-fast: false
13+
matrix:
14+
os: [windows-latest, ubuntu-latest]
15+
dotnet: [5.0.400]
16+
runs-on: ${{ matrix.os }}
17+
18+
steps:
19+
- uses: actions/checkout@v1
20+
21+
- name: Setup .NET Core
22+
# Fix for https://github.com/actions/setup-dotnet/issues/29#issuecomment-548740241
23+
uses: actions/setup-dotnet@v1
24+
with:
25+
dotnet-version: ${{ matrix.dotnet }}
26+
27+
- name: Build on Windows
28+
if: matrix.os == 'windows-latest'
29+
run: .\build.cmd
30+
31+
- name: Build on Unix
32+
if: matrix.os != 'windows-latest'
33+
run: ./build.sh
34+
35+
- name: Deploy documentation from master
36+
if: matrix.os != 'windows-latest'
37+
uses: peaceiris/actions-gh-pages@v3
38+
with:
39+
personal_token: ${{ secrets.GITHUB_TOKEN }}
40+
publish_dir: ./output
41+
publish_branch: gh-pages
42+
force_orphan: true
43+
44+
- name: Examine outputs
45+
if: matrix.os != 'windows-latest'
46+
run: ls -r .
47+
48+
- name: Publish SDK NuGet (if this version not published before)
49+
if: matrix.os != 'windows-latest'
50+
run: dotnet nuget push src\bin\Release\*.nupkg -s https://api.nuget.org/v3/index.json -k ${{ secrets.NUGET_ORG_TOKEN }} --skip-duplicate
51+
52+
- name: Publish template NuGet (if this version not published before)
53+
if: matrix.os != 'windows-latest'
54+
run: dotnet nuget push templates\bin\Release\*.nupkg -s https://api.nuget.org/v3/index.json -k ${{ secrets.NUGET_ORG_TOKEN }} --skip-duplicate
55+

‎Directory.Build.props

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<Project>
2+
<PropertyGroup>
3+
<Authors>FSharp.TypeProviders.SDK contributors</Authors>
4+
<PackageLicenseExpression>MIT</PackageLicenseExpression>
5+
<PackageProjectUrl>https://github.com/fsprojects/FSharp.TypeProviders.SDK#the-f-type-provider-sdk</PackageProjectUrl>
6+
<RepositoryUrl>http://github.com/fsprojects/FSharp.TypeProviders.SDK</RepositoryUrl>
7+
<RepositoryType>git</RepositoryType>
8+
<Copyright>Copyright 2020 FSharp.TypeProviders.SDK contributors</Copyright>
9+
<PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
10+
<Version>2.0.1</Version>
11+
</PropertyGroup>
12+
</Project>

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ Here your test project is referencing your provider project, and your type provi
166166
In the compilation of your test project you will see something like this:
167167

168168
C:\Program Files\dotnet\dotnet.exe "C:\Program Files\dotnet\sdk\3.1.401\FSharp\fsc.exe"
169-
-o:obj\Debug\netcoreapp3.1\Joe.Test.dll
169+
-o:obj\Debug\net5.0\Joe.Test.dll
170170
...
171171
-r:E:\GitHub\admin\joe-provider\src\Joe.Provider\bin\Debug\netstandard2.0\Joe.Provider.dll
172172
...

‎examples/BasicProvider.Runtime/BasicProvider.Runtime.fsproj

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<PropertyGroup>
44
<OutputType>Library</OutputType>
55
<TargetFramework>netstandard2.0</TargetFramework>
6-
<GenerateDocumentationFile>true</GenerateDocumentationFile>
76
<FSharpToolsDirectory>typeproviders</FSharpToolsDirectory>
87
<PackagePath>typeproviders</PackagePath>
8+
<GenerateDocumentationFile>false</GenerateDocumentationFile>
99
</PropertyGroup>
1010

1111
<ItemGroup>
@@ -14,9 +14,6 @@
1414

1515
<ItemGroup>
1616
<PackageReference Update="FSharp.Core" Version="4.7.2" />
17-
</ItemGroup>
18-
19-
<ItemGroup>
2017
<ProjectReference Include="..\BasicProvider.DesignTime\BasicProvider.DesignTime.fsproj">
2118
<IsFSharpDesignTimeProvider>true</IsFSharpDesignTimeProvider>
2219
<PrivateAssets>all</PrivateAssets>

‎examples/StressProvider/StressProvider.fsproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
<PropertyGroup>
44
<TargetFramework>netstandard2.0</TargetFramework>
55
<AppendRuntimeIdentifierToOutputPath>false</AppendRuntimeIdentifierToOutputPath>
6-
<GenerateDocumentationFile>true</GenerateDocumentationFile>
76
<DisableImplicitFSharpCoreReference>true</DisableImplicitFSharpCoreReference>
7+
<GenerateDocumentationFile>false</GenerateDocumentationFile>
88
</PropertyGroup>
99
<ItemGroup>
1010
<Compile Include="..\..\src\ProvidedTypes.fsi" />

‎src/AssemblyInfo.fs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
module AssemblyInfo
1+
namespace AssemblyInfo
22

33
open System.Runtime.CompilerServices
44

‎src/FSharp.TypeProviders.SDK.fsproj

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,10 @@
33
<TargetFramework>netstandard2.0</TargetFramework>
44
<OutputType>Library</OutputType>
55
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
6-
<PackageId>FSharp.TypeProviders.SDK</PackageId>
7-
<Version>1.0.0</Version>
8-
<Authors>FSharp.TypeProviders.SDK contributors</Authors>
9-
<PackageLicenseExpression>MIT</PackageLicenseExpression>
10-
<PackageProjectUrl>https://github.com/fsprojects/FSharp.TypeProviders.SDK#the-f-type-provider-sdk</PackageProjectUrl>
11-
<RepositoryUrl>http://github.com/fsprojects/FSharp.TypeProviders.SDK</RepositoryUrl>
12-
<RepositoryType>git</RepositoryType>
136
<PackageIcon>logo.png</PackageIcon>
14-
<PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
157
<Description>The core implementation of an F# type provider</Description>
16-
<Copyright>Copyright 2020 FSharp.TypeProviders.SDK contributors</Copyright>
178
<Tags>F# fsharp typeprovider</Tags>
9+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
1810
</PropertyGroup>
1911
<ItemGroup>
2012
<Compile Include="AssemblyInfo.fs" />

‎templates/FSharp.TypeProviders.Templates.proj

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,6 @@
11
<Project Sdk="Microsoft.NET.Sdk">
22
<PropertyGroup>
33
<Description>`dotnet new` template for building F# Type Providers.</Description>
4-
<Authors>https://github.com/fsprojects/FSharp.TypeProviders.SDK contributors</Authors>
5-
<License>MIT</License>
6-
<PackageProjectUrl>https://github.com/fsprojects/FSharp.TypeProviders.SDK#the-f-type-provider-sdk</PackageProjectUrl>
7-
<RepositoryUrl>http://github.com/fsprojects/FSharp.TypeProviders.SDK</RepositoryUrl>
8-
<RepositoryType>git</RepositoryType>
94
<PackageIcon>logo.png</PackageIcon>
105
<PackageTags>F#;type provider</PackageTags>
116
<NeutralLanguage>en-US</NeutralLanguage>
@@ -25,7 +20,7 @@
2520
**/.ionide/**/*;
2621
**/.suo;
2722
</ExcludeFromPackage>
28-
</PropertyGroup>
23+
</PropertyGroup>
2924
<ItemGroup>
3025
<Content Include="content/**/*" Exclude="$(ExcludeFromPackage)" >
3126
<PackagePath>content\</PackagePath>

0 commit comments

Comments
 (0)