From e7975da9679044a90b3b033c8931540e90b911da Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebasti=C3=A1n=20Ram=C3=ADrez?= Date: Mon, 25 Mar 2024 15:41:06 -0500 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Add=20docs=20about=20CI=20keys,?= =?UTF-8?q?=20LATEST=5FCHANGES=20and=20SMOKESHOW=5FAUTH=5FKEY=20(#1126)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/latest-changes.yml | 2 +- deployment.md | 7 +++++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/.github/workflows/latest-changes.yml b/.github/workflows/latest-changes.yml index 759ee80..4bda7c0 100644 --- a/.github/workflows/latest-changes.yml +++ b/.github/workflows/latest-changes.yml @@ -29,7 +29,7 @@ jobs: - uses: actions/checkout@v4 with: # To allow latest-changes to commit to the main branch - token: ${{ secrets.FULL_STACK_FASTAPI_POSTGRESQL_LATEST_CHANGES }} + token: ${{ secrets.LATEST_CHANGES }} - uses: docker://tiangolo/latest-changes:0.3.0 # - uses: tiangolo/latest-changes@main with: diff --git a/deployment.md b/deployment.md index 85800a9..6727d29 100644 --- a/deployment.md +++ b/deployment.md @@ -143,6 +143,13 @@ You can set several variables, like: * `POSTGRES_DB`: The database name to use for this application. You can leave the default of `app`. * `SENTRY_DSN`: The DSN for Sentry, if you are using it. +## GitHub Actions Environment Variables + +There are some environment variables only used by GitHub Actions that you can configure: + +* `LATEST_CHANGES`: Used by the GitHub Action [latest-changes](https://github.com/tiangolo/latest-changes) to automatically add release notes based on the PRs merged. It's a personal access token, read the docs for details. +* `SMOKESHOW_AUTH_KEY`: Used to handle and publish the code coverage using [Smokeshow](https://github.com/samuelcolvin/smokeshow), follow their instructions to create a (free) Smokeshow key. + ### Generate secret keys Some environment variables in the `.env` file have a default value of `changethis`.