OSS-775: Create docs for C# driver (#169)

shestakovg · web-flow · commit 181e1a2ea380 · 2021-10-18T15:41:39.000+03:00
diff --git a/README.md b/README.md
@@ -3,6 +3,12 @@
 [![NuGet](https://img.shields.io/nuget/v/FaunaDB.Client.svg?maxAge=21600)](https://www.nuget.org/packages/FaunaDB.Client/)
 [![License](https://img.shields.io/badge/license-MPL_2.0-blue.svg?maxAge=2592000)](https://raw.githubusercontent.com/fauna/faunadb-csharp/main/LICENSE)
 
+## Documentation
+
+C# doc are hosted on GitHub:
+
+* [faunadb-csharp](https://fauna.github.io/faunadb-csharp/4.1.0/)
+
 ## How to Build
 
 ### Requirements
diff --git a/concourse/pipeline.yml b/concourse/pipeline.yml
@@ -5,15 +5,24 @@ resources:
     icon: github
     source:
       uri: https://github.com/fauna/faunadb-csharp
-      branch: main
+      branch: v4
+      
+  - name: fauna-csharp-repository-docs
+    type: git
+    icon: github
+    source:
+      uri: git@github.com:fauna/faunadb-csharp.git
+      branch: gh-pages
+      private_key: ((github_repo_key))
 
 jobs:
   - name: release
     serial: true
     public: false
     plan:
       - get: fauna-csharp-repository
-
+      - get: fauna-csharp-repository-docs
+      
       - task: integration-tests
         file: fauna-csharp-repository/concourse/tasks/integration-tests.yml
         privileged: true
@@ -28,3 +37,10 @@ jobs:
         file: fauna-csharp-repository/concourse/tasks/publish.yml
         params:
           NUGET_API_KEY: ((nuget_api_key))
+
+      - task: publish-docs
+        file: fauna-csharp-repository/concourse/tasks/publish-docs.yml
+
+      - put: fauna-csharp-repository-docs
+        params:
+          repository: fauna-csharp-repository-updated-docs
diff --git a/concourse/scripts/body_gtm.dat b/concourse/scripts/body_gtm.dat
@@ -0,0 +1 @@
+<!-- Google Tag Manager (noscript) --><noscript><iframe src="https:\/\/www.googletagmanager.com\/ns.html?id=GTM-TGTQJ7M" height="0" width="0" style="display:none;visibility:hidden"><\/iframe><\/noscript><!-- End Google Tag Manager (noscript) -->
diff --git a/concourse/scripts/head_gtm.dat b/concourse/scripts/head_gtm.dat
@@ -0,0 +1 @@
+<!-- Google Tag Manager --><script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='https:\/\/www.googletagmanager.com\/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-TGTQJ7M');<\/script><!-- End Google Tag Manager -->
diff --git a/concourse/scripts/publish_docs.sh b/concourse/scripts/publish_docs.sh
@@ -0,0 +1,51 @@
+#!/bin/sh
+set -eou
+cd ./fauna-csharp-repository
+
+apk add xmlstarlet
+PACKAGE_VERSION=$(xml sel -t -v "/Project/PropertyGroup/Version" ./FaunaDB.Client/FaunaDB.Client.csproj)
+
+echo "Current docs version: $PACKAGE_VERSION"
+cd ../
+git clone fauna-csharp-repository-docs fauna-csharp-repository-updated-docs
+
+cd fauna-csharp-repository-updated-docs
+
+mkdir "${PACKAGE_VERSION}"
+cd "${PACKAGE_VERSION}"
+
+sed -i.bak "s/_DOC_VERSION_/${PACKAGE_VERSION}/" ../../fauna-csharp-repository/doc/Doxyfile
+
+apk add doxygen
+
+doxygen "../../fauna-csharp-repository/doc/Doxyfile"
+rm -r man
+rm -r latex
+cp -a ./html/. ./
+rm -r html
+
+echo "Documentation created"
+
+apk add --no-progress --no-cache sed
+
+echo "================================="
+echo "Adding google manager tag to head"
+echo "================================="
+
+HEAD_GTM=$(cat ../../fauna-csharp-repository/concourse/scripts/head_gtm.dat)
+sed -i.bak "0,/<\/title>/{s/<\/title>/<\/title>${HEAD_GTM}/}" ./index.html
+
+echo "================================="
+echo "Adding google manager tag to body"
+echo "================================="
+
+BODY_GTM=$(cat ../../fauna-csharp-repository/concourse/scripts/body_gtm.dat)
+sed -i.bak "0,/<body>/{s/<body>/<body>${BODY_GTM}/}" ./index.html
+
+rm ./index.html.bak
+
+git config --global user.email "nobody@fauna.com"
+git config --global user.name "Fauna, Inc"
+
+git add -A
+git commit -m "Update docs to version: $PACKAGE_VERSION"
diff --git a/concourse/tasks/publish-docs.yml b/concourse/tasks/publish-docs.yml
@@ -0,0 +1,17 @@
+---
+platform: linux
+image_resource:
+  type: registry-image
+  source:
+    repository: mcr.microsoft.com/dotnet/sdk
+    tag: 5.0-alpine
+
+inputs:
+  - name: fauna-csharp-repository
+  - name: fauna-csharp-repository-docs
+
+outputs:
+  - name: fauna-csharp-repository-updated-docs
+
+run:
+  path: ./fauna-csharp-repository/concourse/scripts/publish_docs.sh
diff --git a/doc/Doxyfile b/doc/Doxyfile

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+<!-- Google Tag Manager (noscript) --><noscript><iframe src="https:\/\/www.googletagmanager.com\/ns.html?id=GTM-TGTQJ7M" height="0" width="0" style="display:none;visibility:hidden"><\/iframe><\/noscript><!-- End Google Tag Manager (noscript) -->`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+<!-- Google Tag Manager --><script>(function(w,d,s,l,i){w[l]=w[l]\|\|[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='https:\/\/www.googletagmanager.com\/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-TGTQJ7M');<\/script><!-- End Google Tag Manager -->`