Added the project template based on the Star Wars API Sample (#419)

Author: Juriyx

.github/workflows/publish_ci.yml

@@ -6,23 +6,28 @@ on:
       - dev
 
 jobs:
-  build:
+  publish:
+  
     runs-on: ubuntu-latest
 
     steps:
     - name: Checkout
       uses: actions/checkout@v3
+      
     - name: Set Build Version
       run: |
         $File = (
           Select-Xml -XPath "/Project/PropertyGroup[@Label='NuGet']/Version" -Path "Directory.Build.targets"
         )[0].Node
-        $Version = $File.InnerText
-        $File.InnerText = "$Version-ci-$env:GITHUB_RUN_ID"
+        $version = "$($File.InnerText)-ci-$Env:GITHUB_RUN_ID"
+        $File.InnerText = $version
         $File.OwnerDocument.Save((Join-Path $PWD.ProviderPath Directory.Build.targets))
+        echo "VERSION=$version" | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf8 -Append
       shell: pwsh
+      
     - name: Install .NET Core
       uses: actions/setup-dotnet@v3
+      
     - name: Add the GitHub source
       run: dotnet nuget add source --username USERNAME --password ${{secrets.GITHUB_TOKEN}} --store-password-in-clear-text --name github "https://nuget.pkg.github.com/fsprojects/index.json"
 
@@ -38,32 +43,43 @@ jobs:
         dotnet pack --no-build --nologo --configuration Release /p:IsNuget=true -o ../../nuget
     - name: Publish FSharp.Data.GraphQL.Shared project to GitHub
       run: |
-        cd src/FSharp.Data.GraphQL.Shared
-        dotnet nuget push ../../nuget/*Shared*.nupkg -s "github" -k ${{secrets.GITHUB_TOKEN}}
+        dotnet nuget push nuget/*Shared*.nupkg -s "github" -k ${{secrets.GITHUB_TOKEN}}
 
     - name: Pack FSharp.Data.GraphQL.Client project
       run: |
         cd src/FSharp.Data.GraphQL.Client
         dotnet pack --no-build --nologo --configuration Release /p:IsNuget=true -o ../../nuget
     - name: Publish FSharp.Data.GraphQL.Client project to GitHub
       run: |
-        cd src/FSharp.Data.GraphQL.Client
-        dotnet nuget push ../../nuget/*Client*.nupkg -s "github" -k ${{secrets.GITHUB_TOKEN}}
+        dotnet nuget push nuget/*Client*.nupkg -s "github" -k ${{secrets.GITHUB_TOKEN}}
 
     - name: Pack FSharp.Data.GraphQL.Server project
       run: |
         cd src/FSharp.Data.GraphQL.Server
         dotnet pack --no-build --nologo --configuration Release /p:IsNuget=true -o ../../nuget
     - name: Publish FSharp.Data.GraphQL.Server project to GitHub
       run: |
-        cd src/FSharp.Data.GraphQL.Server
-        dotnet nuget push ../../nuget/*Server*.nupkg -s "github" -k ${{secrets.GITHUB_TOKEN}}
+        dotnet nuget push nuget/*Server*.nupkg -s "github" -k ${{secrets.GITHUB_TOKEN}}
 
     - name: Pack FSharp.Data.GraphQL.Server.Middleware project
       run: |
         cd src/FSharp.Data.GraphQL.Server.Middleware
         dotnet pack --nologo --configuration Release /p:IsNuget=true -o ../../nuget
     - name: Publish FSharp.Data.GraphQL.Server.Middleware project to GitHub
       run: |
-        cd src/FSharp.Data.GraphQL.Server.Middleware
-        dotnet nuget push ../../nuget/*Server.Middleware*.nupkg -s "github" -k ${{secrets.GITHUB_TOKEN}}
+        dotnet nuget push nuget/*Server.Middleware*.nupkg -s "github" -k ${{secrets.GITHUB_TOKEN}}
+
+    - name: Prepare the sample project to be packed as a project template
+      run: |
+        & "./Prepare template project for packing.ps1"
+      shell: pwsh
+
+    - name: Pack FSharp.Data.GraphQL.ProjectTemplates template project
+      run: |
+        cd samples
+        dotnet pack --nologo --configuration Release -o ../nuget
+    - name: Publish FSharp.Data.GraphQL.ProjectTemplates project to GitHub
+      run: |
+        $path = "nuget/FSharp.Data.GraphQL.ProjectTemplates.$Env:VERSION.nupkg"
+        dotnet nuget push $path -s "github" -k ${{secrets.GITHUB_TOKEN}}
+      shell: pwsh

.github/workflows/publish_release.yml

@@ -15,16 +15,16 @@ jobs:
       with:
         # This is necessary so that we have the tags.
         fetch-depth: 0
+        
     - name: Set Build Version
       run: |
-        $Version = "$env:GITHUB_REF_NAME"
-
+        $version = "$env:GITHUB_REF_NAME"
         $File = (
           Select-Xml -XPath "/Project/PropertyGroup[@Label='NuGet']/Version" -Path "Directory.Build.targets"
         )[0].Node
-
-        $File.InnerText = $Version
+        $File.InnerText = $version
         $File.OwnerDocument.Save((Join-Path $PWD.ProviderPath Directory.Build.targets))
+        echo "VERSION=$version" | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf8 -Append
       shell: pwsh
 
     - name: Install .NET Core
@@ -42,32 +42,43 @@ jobs:
         dotnet pack --no-build --nologo --configuration Release /p:IsNuget=true -o ../../nuget
     - name: Publish FSharp.Data.GraphQL.Shared project to NuGet
       run: |
-        cd src/FSharp.Data.GraphQL.Shared
-        dotnet nuget push ../../nuget/*Shared*.nupkg -k ${{secrets.NUGET_SECRET}}
+        dotnet nuget push nuget/*Shared*.nupkg -k ${{secrets.NUGET_SECRET}}
 
     - name: Pack FSharp.Data.GraphQL.Client project
       run: |
         cd src/FSharp.Data.GraphQL.Client
         dotnet pack --no-build --nologo --configuration Release /p:IsNuget=true -o ../../nuget
     - name: Publish FSharp.Data.GraphQL.Client project to NuGet
       run: |
-        cd src/FSharp.Data.GraphQL.Client
-        dotnet nuget push ../../nuget/*Client*.nupkg -k ${{secrets.NUGET_SECRET}}
+        dotnet nuget push nuget/*Client*.nupkg -k ${{secrets.NUGET_SECRET}}
 
     - name: Pack FSharp.Data.GraphQL.Server project
       run: |
         cd src/FSharp.Data.GraphQL.Server
         dotnet pack --no-build --nologo --configuration Release /p:IsNuget=true -o ../../nuget
     - name: Publish FSharp.Data.GraphQL.Server project to NuGet
       run: |
-        cd src/FSharp.Data.GraphQL.Server
-        dotnet nuget push ../../nuget/*Server*.nupkg -k ${{secrets.NUGET_SECRET}}
+        dotnet nuget push nuget/*Server*.nupkg -k ${{secrets.NUGET_SECRET}}
 
     - name: Pack FSharp.Data.GraphQL.Server.Middleware project
       run: |
         cd src/FSharp.Data.GraphQL.Server.Middleware
         dotnet pack --nologo --configuration Release /p:IsNuget=true -o ../../nuget
     - name: Publish FSharp.Data.GraphQL.Server.Middleware project to NuGet
       run: |
-        cd src/FSharp.Data.GraphQL.Server.Middleware
-        dotnet nuget push ../../nuget/*Server.Middleware*.nupkg -k ${{secrets.NUGET_SECRET}}
+        dotnet nuget push nuget/*Server.Middleware*.nupkg -k ${{secrets.NUGET_SECRET}}
+
+    - name: Prepare the sample project to be packed as a project template
+      run: |
+        & "./Prepare template project for packing.ps1"
+      shell: pwsh
+
+    - name: Pack FSharp.Data.GraphQL.ProjectTemplates template project
+      run: |
+        cd samples
+        dotnet pack --nologo --configuration Release -o ../nuget
+    - name: Publish FSharp.Data.GraphQL.ProjectTemplates project to GitHub
+      run: |
+        $path = "nuget/FSharp.Data.GraphQL.ProjectTemplates.$Env:VERSION.nupkg"
+        dotnet nuget push $path -k ${{secrets.NUGET_SECRET}}
+      shell: pwsh

Directory.Build.targets

@@ -16,12 +16,14 @@
 
     <RepoRoot>$([System.IO.Path]::GetDirectoryName($([MSBuild]::GetPathOfFileAbove('.gitignore', '$(MSBuildThisFileDirectory)'))))</RepoRoot>
     <RepositoryUrl>https://github.com/fsprojects/FSharp.Data.GraphQL</RepositoryUrl>
+    <RepositoryType>git</RepositoryType>
     <Version>2.0.0</Version>
     <PackageTags>FSharp GraphQL Relay React Middleware</PackageTags>
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageIcon>icon.png</PackageIcon>
     <!--<PackageIconUrl>https://www.newtonsoft.com/content/images/nugeticon.png</PackageIconUrl>-->
     <PackageProjectUrl>https://fsprojects.github.io/FSharp.Data.GraphQL</PackageProjectUrl>
+    <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
     <IncludeSymbols>true</IncludeSymbols>

Packages.props

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+<Project>
   <PropertyGroup>
     <MicrosoftExtensionsVersion>6.0.*</MicrosoftExtensionsVersion>
     <AspNetCoreVersion>6.0.*</AspNetCoreVersion>

Prepare template project for packing.ps1

@@ -0,0 +1,27 @@
+$starWarsApiProjPath = "samples/star-wars-api/FSharp.Data.GraphQL.Samples.StarWarsApi.fsproj"
+[xml]$starWarsApiProj = Get-Content -Path $starWarsApiProjPath
+$starWarsApiProjRefNode = $starWarsApiProj.SelectSingleNode("//ItemGroup[@Label='ProjectReferences']")
+$starWarsApiProjRefNode.ParentNode.RemoveChild($starWarsApiProjRefNode) | Out-Null
+
+$dirBuildTargetsPath = "Directory.Build.targets"
+[xml]$dirBuildTargets = Get-Content -Path $dirBuildTargetsPath
+$version = $dirBuildTargets.SelectSingleNode("//PropertyGroup[@Label='NuGet']/Version").InnerText
+
+[xml]$fsharpPackages = @"
+<ItemGroup Label="PackageReferences">
+    <PackageReference Include="FSharp.Data.GraphQL.Server.Middleware" Version="$($version)" />
+    <PackageReference Include="FSharp.Data.GraphQL.Server" Version="$($version)" />
+    <PackageReference Include="FSharp.Data.GraphQL.Shared" Version="$($version)" />
+</ItemGroup>
+"@
+
+$packagesPropsPath = "Packages.props"
+[xml]$packagesProps = Get-Content -Path $packagesPropsPath
+$giraffeVersion = $packagesProps.SelectSingleNode("//PackageReference[@Update='Giraffe']/@Version")
+$starWarsApiProj.SelectSingleNode("//ItemGroup[@Label='PackageReferences']/PackageReference[@Include='Giraffe']").SetAttribute("Version",$giraffeVersion.Value)
+$packageReferences = $starWarsApiProj.SelectSingleNode("//ItemGroup[@Label='PackageReferences']")
+foreach($packageReference in $fsharpPackages.DocumentElement.ChildNodes){
+    $innerNode = $starWarsApiProj.ImportNode($packageReference,$true)
+    $packageReferences.AppendChild($innerNode)
+}
+$starWarsApiProj.Save($starWarsApiProjPath)

README.md

@@ -6,6 +6,16 @@ F# implementation of Facebook [GraphQL query language specification](https://fac
 
 [![Join the chat at https://gitter.im/FSharp-Data-GraphQL/community](https://badges.gitter.im/FSharp-Data-GraphQL/community.svg)](https://gitter.im/FSharp-Data-GraphQL/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
+## Installing project templates
+
+Type the following commands to install the template for creating web applications:
+
+From GitHub:
+`dotnet new -i "FSharp.Data.GraphQL::2.0.0-ci-*" --nuget-source "https://nuget.pkg.github.com/fsprojects/index.json"`
+
+From NuGet:
+`dotnet new -i "FSharp.Data.GraphQL::2.0.0"`
+
 ## Quick start
 
 ```fsharp

build.fsx

@@ -90,7 +90,7 @@ let startGraphQLServer (project : string) (streamRef : DataRef<Stream>) =
         </> DotNetMoniker
         </> (projectName + ".dll")
 
-    CreateProcess.fromRawCommandLine "dotnet" serverExe
+    CreateProcess.fromRawCommandLine "dotnet" $"{serverExe} --urls=http://localhost:8086/"
     |> CreateProcess.withStandardInput (CreatePipe streamRef)
     |> Proc.start
     |> ignore

icon.png

@@ -0,0 +1,25 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <PackageType>Template</PackageType>
+    <PackageId>FSharp.Data.GraphQL.ProjectTemplates</PackageId>
+    <Title>FSharp.Data.GraphQL project templates</Title>
+    <Description>Templates to use when creating a GraphQL API aplication in F#.</Description>
+    <PackageTags>dotnet-new;templates;graphql;giraffe;api;fsharp;f#</PackageTags>
+    <PackageReleaseNotes>https://github.com/fsprojects/FSharp.Data.GraphQL/releases</PackageReleaseNotes>
+
+    <TargetFramework>net6.0</TargetFramework>
+
+    <IncludeContentInPack>true</IncludeContentInPack>
+    <IncludeBuildOutput>false</IncludeBuildOutput>
+    <ContentTargetFolders>content</ContentTargetFolders>
+    <NoWarn>$(NoWarn);NU5128</NoWarn>
+    <NoDefaultExcludes>true</NoDefaultExcludes>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <Content Include="samples/star-wars-api/**/*" Exclude="samples/star-wars-api/**/bin/**;samples/star-wars-api/**/obj/**" />
+    <Compile Remove="**/*" />
+  </ItemGroup>
+
+</Project>

samples/FSharp.Data.GraphQL.ProjectTemplates.fsproj

@@ -0,0 +1,134 @@
+{
+  "$schema": "http://json.schemastore.org/dotnetcli.host",
+  "symbolInfo": {
+    "Title": {
+      "longName": "title"
+    },
+    "TitleXmlEncoded": {
+      "isHidden": true
+    },
+    "Description": {
+      "longName": "description"
+    },
+    "DescriptionXmlEncoded": {
+      "isHidden": true
+    },
+    "Author": {
+      "longName": "author"
+    },
+    "AuthorXmlEncoded": {
+      "isHidden": true
+    },
+    "Contact": {
+      "longName": "contact"
+    },
+    "ContactXmlEncoded": {
+      "isHidden": true
+    },
+    "EditorConfig": {
+      "longName": "editorconfig"
+    },
+    "SourceControl": {
+      "longName": "source-control"
+    },
+    "GitHubUsername": {
+      "longName": "github-username"
+    },
+    "GitHubProject": {
+      "longName": "github-project"
+    },
+    "ReadMe": {
+      "longName": "readme"
+    },
+    "TreatWarningsAsErrors": {
+      "longName": "treat-warnings-as-errors"
+    },
+    "Mutations": {
+      "longName": "mutations"
+    },
+    "Subscriptions": {
+      "longName": "subscriptions"
+    },
+    "PersistedQueries": {
+      "longName": "persisted-queries"
+    },
+    "ForwardedHeaders": {
+      "longName": "forwarded-headers"
+    },
+    "HostFiltering": {
+      "longName": "host-filtering"
+    },
+    "ReverseProxyWebServer": {
+      "longName": "reverse-proxy"
+    },
+    "CloudProvider": {
+      "longName": "cloud-provider"
+    },
+    "OpenTelemetry": {
+      "longName": "open-telemetry"
+    },
+    "Logging": {
+      "longName": "logging"
+    },
+    "ApplicationInsights": {
+      "longName": "app-insights"
+    },
+    "ApplicationInsightsKey": {
+      "longName": "app-insights-key"
+    },
+    "HttpsEverywhere": {
+      "longName": "https-everywhere"
+    },
+    "HstsPreload": {
+      "longName": "hsts-preload"
+    },
+    "Authorization": {
+      "longName": "authorization"
+    },
+    "CORS": {
+      "longName": "cors"
+    },
+    "ResponseCompression": {
+      "longName": "response-compression"
+    },
+    "DistributedCache": {
+      "longName": "distributed-cache"
+    },
+    "HealthCheck": {
+      "longName": "health-check"
+    },
+    "RobotsTxt": {
+      "longName": "robots-txt"
+    },
+    "SecurityTxt": {
+      "longName": "security-txt"
+    },
+    "HumansTxt": {
+      "longName": "humans-txt"
+    },
+    "HttpPort": {
+      "longName": "http-port"
+    },
+    "HttpsPort": {
+      "longName": "https-port"
+    },
+    "IISExpressHttpPort": {
+      "longName": "iis-express-http-port"
+    },
+    "IISExpressHttpsPort": {
+      "longName": "iis-express-https-port"
+    },
+    "IntegrationTest": {
+      "longName": "integration-test"
+    },
+    "StyleCop": {
+      "longName": "style-cop"
+    },
+    "GitHubActions": {
+      "longName": "github-actions"
+    },
+    "SkipOpenToDo": {
+      "longName": "no-open-todo"
+    }
+  }
+}