nt_web_template/full-stack-fastapi-template
2
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

📝 Add docs about CI keys, LATEST_CHANGES and SMOKESHOW_AUTH_KEY (#1126)

Browse Source
This commit is contained in:
Sebastián Ramírez
2024-03-25 15:41:06 -05:00
committed by GitHub
parent 90252c9804
commit e7975da967
2 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/latest-changes.yml vendored
View File

@@ -29,7 +29,7 @@ jobs:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
with: with:
# To allow latest-changes to commit to the main branch # 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: docker://tiangolo/latest-changes:0.3.0
# - uses: tiangolo/latest-changes@main # - uses: tiangolo/latest-changes@main
with: with:

7
deployment.md
View File

@@ -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`. * `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. * `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 ### Generate secret keys
Some environment variables in the `.env` file have a default value of `changethis`. Some environment variables in the `.env` file have a default value of `changethis`.