-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: document how our builds on Heroku are controlled
- Loading branch information
Showing
1 changed file
with
17 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
Our production Heroku deployment is controlled by the following files: | ||
- `Procfile`: tells Heroku what command to launch in each Dyno; | ||
- `runtime.txt`: tells Heroku which run-time engine to use (i.e., which version of Python); | ||
|
||
Heroku detects Python by default, but `runtime.txt` lets us specify/bump the version as needed; | ||
- `requirements.txt`: tells Heroku what our production dependencies are. | ||
|
||
Updating `g2p`: | ||
- By default, `g2p` only gets updated for `readalong-studio` on Heroku when: | ||
- we make a new release of `g2p` on PyPI | ||
- we update `requirements.min.txt` here to ask for that release | ||
- Manual override: it is also possible to update g2p to the current commit on the `main` branch using this procedure: | ||
- Change `requirements.min.txt` to specify `g2p @ git+https://github.com/roedoejet/g2p@main`. | ||
- Commit that change to `main` in a sandbox connected to Heroku. | ||
- `git push heroku main` | ||
- This will force a build which will fetch the main branch of g2p from GitHub. | ||
- Subsequent builds reuse the cached g2p, so they'll reuse this one. Exception: if `runtime.txt` is updated, a fresh build is done and g2p will be reverted to the latest published version. |