branderson
0fc4ad0e08
tests / test (pull_request_target) Successful in 4m18s
Publishing a prebuilt image can wait. Remove the GitHub Actions image workflow and the IMAGE_PREFIX/IMAGE_TAG image name in docker-compose.yml, and have the README's quick start build with docker compose up -d --build, which also rebuilds after a git pull. The mirror's docs and script no longer mention Actions or the package.
26 lines
1.1 KiB
Markdown
26 lines
1.1 KiB
Markdown
# GitHub mirror
|
|
|
|
songtrace is developed on a private forge. `github-mirror.sh` publishes its
|
|
`main` and the tags on `main` to
|
|
[github.com/branderson/songtrace](https://github.com/branderson/songtrace),
|
|
hourly, from a host that can push to GitHub. Issues and pull requests are off
|
|
there.
|
|
|
|
The mirror's `main` is the forge's plus one commit, which adds a read-only notice
|
|
under the README's title. Every forge commit is in the mirror unchanged, and
|
|
each sync fast-forwards. If the README loses its `# ` title, the sync stops
|
|
instead of publishing without the notice.
|
|
|
|
## Setup
|
|
|
|
1. Set up the timer as described at the top of
|
|
`songtrace-github-mirror.service`. Give it a deploy key with write access to
|
|
the GitHub repository.
|
|
2. Run `github-mirror.sh --dry-run` to build what a sync would publish without
|
|
pushing it.
|
|
3. Once the first sync has pushed, run `github-mirror.sh --settings` (needs
|
|
`gh`). It turns off issues, pull requests, projects, wiki and discussions.
|
|
|
|
The timer runs a copy of the script, not the checkout's. Reinstall it after
|
|
reviewing a change to `mirror/`.
|