Skip to content

Commit 1800f80

Browse files
committed
enhancement: make forking experience better
This tweaks the GHA configuration slightly to avoid requiring that the new fork's owner modify the GHA configuration with their repository URL. It also adds a note in the README that the container build requires a user-supplied secret in order to function correctly.
1 parent ea796df commit 1800f80

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

.github/workflows/main.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ jobs:
5656
- name: Docker Prep
5757
id: prep
5858
run: |
59-
DOCKER_IMAGE=ghcr.io/coderanger/migrations-operator
59+
DOCKER_IMAGE="$(echo ghcr.io/${{ github.repository }} | tr '[:upper:]' '[:lower:]')"
6060
VERSION=edge
6161
if [[ $GITHUB_REF == refs/tags/* ]]; then
6262
VERSION=${GITHUB_REF#refs/tags/}

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,9 @@ A common choice for running database migrations is the `pre-install/upgrade` hoo
6262
### Migrations-Operator vs. Init Container
6363

6464
Another common solution for database migrations is an init container to run the migration commands. The main problem here is locking, if you run 4 replicas of your application, all 4 of those are going to try and apply your migrations in parallel. You could add some leader election code to your migrations runner, however this has to be built in at the application image level and so requires a specific solution for each application framework or toolkit. Migrations-Operator has a top-level view of the world and so can ensure for only a single job at a time is created.
65+
66+
## Development
67+
68+
### Setting up GitHub Actions
69+
70+
In order for Actions to be able to push a container image into GHCR, a `GHCR_PAT` secret must be present on the repository. A container image will only be built on pushes to the default branch.

0 commit comments

Comments
 (0)