🐳 [GH-67] Add DigitalOcean app-platform deploy support (#73)

* feat: add digitalocean app-platform deploy option [#67]

* fix: yaml updates after testing [#67]

* chore: clean up yaml [#67]

* chore: fix do deploy and update documentation [#67]

* docs: update README [#67]

* docs: clean up [#67]

* fix: add missing env vars from deploy step [#67]

Author: nickatnight

.github/workflows/main.yml

@@ -19,6 +19,7 @@ jobs:
     uses: ./.github/workflows/test.yml
 
   create-release:
+    if: startsWith(github.ref, 'refs/tags/')
     permissions:
       contents: write
     needs: [lint, tests]

README.md

@@ -19,12 +19,12 @@
 
 Supported PaaS's:
 - Render
+- DigitalOcean
 - Platform.sh (Coming soon)
 - Fly.io (Coming soon)
-- DigitalOcean (Coming soon)
 
 ## Quickstart
-Install the latest Cookiecutter if you haven't installed it yet (this requires Cookiecutter 1.4.0 or higher):
+Install the latest Cookiecutter if you haven't installed it yet:
 ```sh
 # pipx is strongly recommended.
 $ pipx install cookiecutter
@@ -57,7 +57,7 @@ cookiecutter("gh:nickatnight/cookiecutter-fastapi-backend")
 * :convenience_store: **Redis** In-memory data structure [store](https://redis.io/), used as a distributed, in-memory key–value database, cache and message broker
 * :gear: **Common** Base models and repository classes for common CRUD operations and database schemas.
 * :seedling: **Celery** [Asynchronous](https://docs.celeryq.dev/en/stable/getting-started/introduction.html) task or job queue
-* :inbox_tray: **Continuous Integration/Deployment** Modular [GitHub Actions](https://github.com/features/actions) to lint, test, and deploy to your favorite platform. Automatically includes [Codecov](https://about.codecov.io/) reporting.
+* :inbox_tray: **Continuous Integration/Deployment** Modular [GitHub Actions](https://github.com/features/actions) to lint, test, and deploy to your favorite platform-as-a-service. Automatically includes [Codecov](https://about.codecov.io/) reporting.
 * :leftwards_arrow_with_hook: **pre-commit** [Git hooks](https://pre-commit.com/) to maintain code quality using modern tooling (ruff, black, isort)
 * :rocket: **Sentry** Application monitoring and error tracking. You can sign up for free at [sentry.io](https://sentry.io/)
 
@@ -76,7 +76,7 @@ The input variables, with their default values (some auto generated) are:
 * `use_celery`: Whether to use Celery/Beat and Redis for asynchronous/scheduled tasks. Default `no`
 * `use_sentry`: Whether to use Sentry for application monitoring and error tracking. Default `no`
 * `github_username`: The username of the GitHub user. Used for badge display in generated project `README.md`
-* `deployments`: Deploy to your favorite platform, Render.com (and more to come). Default `none`
+* `deployments`: Deploy to your favorite platform, Render.com, DigitalOcean, (and more to come). Default `none`
 
 ## Documentation
 See full documentation [here](https://cookiecutter-fastapi-backend.readthedocs.io/en/latest/).

cookiecutter.json

@@ -13,5 +13,5 @@
     "use_sentry": ["no", "yes"],
     "github_username": "change.me",
 
-    "deployments": ["none", "render"]
+    "deployments": ["none", "render", "digitalocean"]
 }

docs/source/project_features/deploy.rst

@@ -7,5 +7,6 @@ Deployments for this project are meant to be painless, and to be achieved in a f
     :maxdepth: 1
     :caption: Deployments
 
+    deployments/digitalocean
     deployments/render
     deployments/platformsh

docs/source/project_features/deployments/digitalocean.rst

@@ -0,0 +1,39 @@
+DigitalOcean
+============
+
+There a couple of house keeping steps to take before deploying to DigitalOcean. You can
+read more about the steps `here <https://docs.digitalocean.com/products/app-platform/how-to/deploy-from-github-actions/#prerequisites>`_.
+
+.. note::
+
+   Be sure you have the official `DigitalOcean GitHub App <https://cloud.digitalocean.com/apps/github/install>`_ installed in your GitHub account.
+   It is recommended to only allow the app to access the repositories you want to deploy.
+
+   Meaning, once your project has been scaffolded with this cookiecutter, you'll have to push
+   it to GitHub for it to be available to DigitalOcean.
+
+Once the prerequisites are met:
+--------------------------------
+
+Provision the app using the provided script ``bin/provision-app.sh``.
+
+.. code-block:: bash
+
+   $ ./bin/provision-app.sh
+
+This creates app based on the spec file ``digitalocean.yaml`` at the root of the project. The services will get created, but
+will fail deployment, which is expected. They fail because we've deployed the app from the CLI without any of the environment variables.
+
+Ensure the following variables are in the Apps Environment Variables, and in your GitHub repository secrets:
+
+- ``POSTGRES_USER``
+- ``POSTGRES_PASSWORD``
+- ``POSTGRES_DB``
+- ``POSTGRES_HOST``
+- ``POSTGRES_PORT``
+
+.. note::
+
+   The environment variables are injected into the ``deploy-app`` step in the GitHub Actions workflow.
+
+Once saved, the deployment for the app will get re-triggered, and the services will be deployed successfully. Now, any merges into your main branch will trigger a deployment.

hooks/post_gen_project.py

@@ -10,6 +10,7 @@
 ]
 DEPLOYMENT_FILES = [
     "render.yaml",
+    "digitalocean.yaml",
 ]
 
 
@@ -32,6 +33,17 @@ def rename_file(old: str, new: str):
     for p in DEPLOYMENT_FILES:
         remove_file(p)
 
+
+if "{{ cookiecutter.deployments }}" == "render":
+    print("Removing digitalocean deployment file(s)...")
+    remove_file("digitalocean.yaml")
+
+
+if "{{ cookiecutter.deployments }}" == "digitalocean":
+    print("Removing render deployment file(s)...")
+    remove_file("render.yaml")
+
+
 if "{{ cookiecutter.use_celery }}" == "no":
     print("Removing celery files...")
     for p in CELERY_FILE_PATHS:

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cookiecutter-fastapi-backend"
-version = "2.3.0"
+version = "2.4.0"
 description = "Cookiecutter template to build and deploy fastapi backends..batteries included"
 authors = [{ name = "nickatnight", email = "nialexanderke@proton.me" }]
 requires-python = ">=3.9"
@@ -9,15 +9,31 @@ dependencies = [
     "cookiecutter==2.6.0",
 ]
 classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
     "Framework :: FastAPI",
     "Intended Audience :: Developers",
+    "Natural Language :: English",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
     "Topic :: Software Development :: Code Generators"
 ]
+keywords=[
+    "cookiecutter",
+    "Python",
+    "projects",
+    "project templates",
+    "Jinja2",
+    "skeleton",
+    "scaffolding",
+    "project directory",
+    "package",
+    "packaging",
+    "FastAPI"
+]
 
 [project.urls]
 Homepage = "https://github.com/nickatnight/cookiecutter-fastapi-backend"

tests/test_bake_project.py

@@ -20,6 +20,7 @@
 SUPPORTED_COMBINATIONS = [
     {"deployments": "none"},
     {"deployments": "render"},
+    {"deployments": "digitalocean"},
     {"use_celery": "no"},
     {"use_celery": "yes"},
     {"py_version": "3.9"},

uv.lock

@@ -16,6 +16,7 @@ jobs:
     uses: ./.github/workflows/unit-tests.yml
 
   create-release:
+    if: startsWith(github.ref, 'refs/tags/')
     permissions:
       contents: write
     runs-on: ubuntu-latest
@@ -27,8 +28,26 @@ jobs:
       - name: Create Release
         id: create_release
         uses: nickatnight/releases-action@v5
-        if: startsWith(github.ref, 'refs/tags/')
         {% raw %}env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}{% endraw %}
     {% raw %}outputs:
       ReleaseTag: ${{ steps.create_release.outputs.release_tag }}{% endraw %}
+  {%- if cookiecutter.deployments == "digitalocean" %}
+  deploy-app:
+   runs-on: ubuntu-latest
+   steps:
+     - name: Checkout repository
+       uses: actions/checkout@v4
+     - name: Deploy the app
+       uses: digitalocean/app_action/deploy@v2
+       {% raw %}env:
+         DIGITALOCEAN_ACCESS_TOKEN: ${{ secrets.DIGITALOCEAN_ACCESS_TOKEN }}
+         POSTGRES_USER: ${{ secrets.POSTGRES_USER }}
+         POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
+         POSTGRES_DB: ${{ secrets.POSTGRES_DB }}
+         POSTGRES_HOST: ${{ secrets.POSTGRES_HOST }}
+         POSTGRES_PORT: ${{ secrets.POSTGRES_PORT }}
+       with:
+         app_spec_location: digitalocean.yaml
+         token: ${{ secrets.DIGITALOCEAN_ACCESS_TOKEN }}{% endraw %}
+  {%- endif %}