Skip to content

RELEASE-HOWTO.md

Latest commit

 

History

History
80 lines (64 loc) · 3.01 KB

RELEASE-HOWTO.md

File metadata and controls

80 lines (64 loc) · 3.01 KB

Release How-To

Smoke test and test with sandbox

  1. On the Mac:
    1. Repo feditest: git checkout develop
    2. In pyproject.toml, change project / version to the new version VERSION (needed so the generated files have the right version in them before check-in)
    3. Clean rebuild:
      1. rm -rf venv.*
      2. make venv
      3. make lint: ruff and mypy show no errors
      4. make tests: unit tests show no errors (smoke tests don't run on macOS)
    4. Repo feditest-tests-sandbox: git checkout develop
    5. Clean re-run and report generation of the sandbox tests:
      1. make -f Makefile.create clean FEDITEST=../feditest/venv.darwin.default/bin/feditest
      2. make -f Makefile.run clean FEDITEST=../feditest/venv.darwin.default/bin/feditest
      3. make -f Makefile.create examples FEDITEST=../feditest/venv.darwin.default/bin/feditest
      4. make -f Makefile.run sandbox FEDITEST=../feditest/venv.darwin.default/bin/feditest
      5. open examples/testresults/*.html and check for plausibility of reports

Smoke test and test quickstart

  1. On UBOS:
    1. Repo feditest: git checkout develop
    2. Clean rebuild:
      1. rm -rf venv.*
      2. make venv
      3. make lint: ruff and mypy show no errors
      4. make tests: unit tests and smoke tests show no errors (other than WordPress timeout-related)
    3. Repo feditest-tests-fediverse: git checkout develop
    4. Clean re-run and report generation of the quickstart tests:
      1. Run quickstart examples from https://feditest.org/quickstart/evaluate/, but instead of feditest use ../feditest/venv.linux.default/bin/feditest.
      2. xdg-open results/*.html and check for plausibility of reports

Tag versions

  1. On the Mac:
    1. Update repo feditest-tests-fediverse, branch develop:
      1. git tag -a vVERSION -m vVERSION
      2. git push
      3. git push --tags
    2. Update repo feditest-tests-sandbox, branch develop:
      1. git tag -a vVERSION -m vVERSION
      2. git push
      3. git push --tags
    3. Update repo feditest, branch develop:
      1. git tag -a vVERSION -m vVERSION
      2. git push
      3. git push --tags

Merge into main

  1. Repo feditest-tests-fediverse: pull request develop into main
  2. Repo feditest-tests-sandbox: pull request develop into main
  3. Repo feditest: pull request develop into main
  4. Approve all three pull requests

Publish to PyPi

  1. On the Mac:
    1. Repo feditest, branch main
    2. make release
    3. venv.release/bin/twine upload dist/*
    4. pip3.11 install --upgrade feditest
    5. feditest version now shows VERSION

Publish to UBOS repos

  1. On UBOS:
    1. Build feditest for the UBOS package repos so it can be installed with pacman -S feditest

Create release notes

  1. Repo: feditest.org: create release notes
  2. git push

Announce

  1. https://matrix.to/#/#fediverse-testing:matrix.org: post link to release notes
  2. @feditest@mastodon.social: post link to release notes