Add DocC deployment template (#13)

ns-vasilev · web-flow · commit d68e99f5ba2d · 2024-01-13T21:09:38.000+01:00
* Add `DocC` deployment template

* Add `CHANGELOG.md`
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,8 @@ All notable changes to this project will be documented in this file.
 ## [Unreleased]
 
 ## Added
+- Add `DocC` deployment template
+  - Added in Pull Request[#13](https://github.com/space-code/package-template/pull/13).
 - Add additional badges to `README.md`
   - Added in Pull Request [#12](https://github.com/space-code/package-template/pull/12).
 - Add files to comply with community standards
diff --git a/cookiecutter.json b/cookiecutter.json
@@ -23,5 +23,9 @@
     "additional_badges": [
         "Yes",
         "No"
+    ],
+    "deploy_docc": [
+        "Yes",
+        "No"
     ]
 }
diff --git a/hooks/post_gen_project.py b/hooks/post_gen_project.py
@@ -0,0 +1,15 @@
+import os
+import shutil
+
+print(os.getcwd())
+
+def remove(filepath):
+    if os.path.isfile(filepath):
+        os.remove(filepath)
+    elif os.path.isdir(filepath):
+        shutil.rmtree(filepath)
+
+create_docc = '{{ cookiecutter.deploy_docc }}' == 'yes'
+
+if not create_docc:
+    remove(os.path.join(os.getcwd(), '.github/workflows', 'deploy_docc.yml'))
diff --git a/{{ cookiecutter.name | lower }}/.github/workflows/deploy_docc.yml b/{{ cookiecutter.name | lower }}/.github/workflows/deploy_docc.yml
@@ -0,0 +1,44 @@
+name: Deploy DocC
+
+on:
+  push:
+    branches: 
+      - main
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      {% raw %}
+      url: ${{ steps.deployment.outputs.page_url }}
+      {% endraw %}
+    runs-on: macos-12
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v3
+      - name: Build DocC
+        run: |
+          swift build;
+          swift package \
+            --allow-writing-to-directory ./docs \
+            generate-documentation \
+            --target {{ cookiecutter.name }} \
+            --output-path ./docs \
+            --transform-for-static-hosting \
+            --hosting-base-path {{ cookiecutter.name | lower }};
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: 'docs'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

Original file line number	Diff line number	Diff line change
`@@ -23,5 +23,9 @@`
`23`	`23`	`"additional_badges": [`
`24`	`24`	`"Yes",`
`25`	`25`	`"No"`
	`26`	`+ ],`
	`27`	`+ "deploy_docc": [`
	`28`	`+ "Yes",`
	`29`	`+ "No"`
`26`	`30`	`]`
`27`	`31`	`}`