Skip to content

How to release Quepid

Eric Pugh edited this page Oct 26, 2026 · 24 revisions

Quepid is a bit of an odd duck, since it's a hosted application at http://go.quepidapp.com, and a Docker image available at https://hub.docker.com/repository/docker/o19s/quepid for Dockerized deploys, and of course a straight up Rails app you can install.

So releasing a new version of Quepid requires a number of steps, some that can only be done (today!) by OSC folks.

  1. Make sure the CHANGELOG.md is up to date. We like to give credit where possible to contributors, so please list their Github name if possible. Since we are cutting a release, set today's date in the Changelog.

  2. Go ahead and create the Release in Github, along with the tag. Copy the relevant section in CHANGELOG.md into the notes.

  3. In the Heroku Console, go ahead and promote the most recent Staging Quepid setup to Production. Right now we need to do some extra steps (https://devcenter.heroku.com/articles/git) due to oauth/github/heroku issues. You will need to run any migrations via:

heroku run bin/rake db:migrate -a quepid  # or quepid-staging ;-)
heroku restart -a quepid # or quepid-staging ;-)
  1. Tag and deploy production optimized Quepid Docker image using Dockerfile.prod to Docker Hub (https://hub.docker.com/repository/docker/o19s/quepid):
export QUEPID_VERSION=8.0.0   # or add -dev or -rc

And run:

docker buildx build --platform linux/amd64,linux/arm64 --build-arg QUEPID_VERSION_VARIABLE=$QUEPID_VERSION -t o19s/quepid:$QUEPID_VERSION -t o19s/quepid:latest -f Dockerfile.prod .

docker push o19s/quepid:$QUEPID_VERSION
docker push o19s/quepid:latest
  1. Smoke-test the image you just pushed against both supported databases before anyone pulls :latest. Quepid's Dockerfile.prod supports either MySQL or SQLite at runtime via DATABASE_URL, and neither the Heroku deploy in step 3 (MySQL-only) nor a plain docker buildx build in step 4 actually exercises either path end to end - a broken db:setup/boot sequence on either adapter will otherwise only surface once a user hits it.

    SQLite:

    docker run -d -p 3080:3000 --name quepid-sqlite -e RAILS_ENV=production \
      -e SECRET_KEY_BASE=$(openssl rand -hex 64) \
      -e DATABASE_URL=sqlite3:storage/production.sqlite3 \
      -e RAILS_SERVE_STATIC_FILES=true -e PORT=3000 \
      o19s/quepid:$QUEPID_VERSION
    

    Confirm it boots, db:setup runs cleanly against a fresh volume, and you can sign up/log in at http://localhost:3080.

    Then stop it via docker stop quepid-sqlite.

    MySQL: Bring up docker-compose.prod.yml (pointed at the new tag) and confirm the same - fresh db:setup, sign up, log in.

  2. Update the Chorus Docker Compose script for the new version. This is a great "last chance" option to test the release version of Quepid. Recommended if you have migrations or other setup changes in a release. See the lessons learned from releases 6.3.1.1 and 6.3.1.2 ;-)

  3. Build the macOS app from the Quepid checkout at the release tag. Verified on Eric's Mac (adjust the Ruby path when the release requires a newer version):

    cd ../quepid-desktop
    ruby scripts/build.rb --source ../quepid \
      --ruby /Users/epugh/.asdf/installs/ruby/4.0.9 \
      --node-bin /Users/epugh/.asdf/installs/nodejs/24.17.0/bin \
      --sdk /Library/Developer/CommandLineTools/SDKs/MacOSX15.5.sdk \
      --version "$QUEPID_VERSION" --dmg
    ruby scripts/smoke.rb dist/Quepid.app

    Open dist/Quepid.app and check it works. Distribute dist/Quepid.dmg after signing and notarization; see the desktop README's Public distribution section.

  4. Make an announcement on Relevance Slack #quepid channel and on Twitter to @quepid_search.

Clone this wiki locally