Skip to content

Making a release

Thomas Jay Rush edited this page Jun 5, 2024 · 20 revisions

Copy this code of this page into an issue to get checkboxes.

Prepare

  • Review and close as many open bugs as possible
  • Review and resolve as many TODO list items as possible.
  • Consider upgrading Go version (search for Go Version)
  • Update VERSION file
  • Run ../scripts/go-work-sync.sh and ../scripts/go-mod-tidy.sh
  • Rerun all tests locally until they pass
  • Make a PR against develop -- make sure all remote tests pass
  • update CHANGES.md and (if needed) MIGRATION.md
  • Choose a Short Name for the release from here: https://github.com/TrueBlocks/trueblocks-manage/issues/85
    • v3.0.0-release Greene - GoLang SDK Alpha

Core

  • Merge the PR into the develop branch
  • In tests repo, make a main branch and merge in develop.
  • reference main tests repo in develop branch.
  • Create a PR from develop to master - make sure all tests pass
  • Merge develop into master
  • Make sure docker version builds with the new master branch
  • Tag the new master (see "Tagging" below). This will cause the docker version to publish to DockerHub.
  • Check GitHub to see that develop is up to date with master
  • Check that docker hub built. Update the scripts in docker/scripts that need to reference new version.
  • Remove any un-needed branches

Make a release (use Release Name - Short Name for title)

Tagging

    git checkout master && \
        git pull && \
        git tag v0.VERSION.0-beta && \
        git push --tags && \
        git checkout develop && \
        git merge master && \
        git push

Docs

  • There is only one branch: main. Check it out and pull.
  • Run make -j 12 && make generate in core repo.
  • Compare ./trueblocks-docs/content against ./trueblocks-core/docs/contents.
  • Push 'main'. It should update the website after linting and link checking.
  • Tag and make the same Release name

Browse

  • WORK IN PROGRESS - PLEASE DISREGARD
  • Update to use the new SDK
  • Make sure it works by opening a few addresses
  • Merge develop to master
  • Tag and Release
  • Make the release

Docker / dAppNode

  • Tagging main of the core repo should automatically publish to docker hub
  • Edit the versions requested in the ./script folder of docker repo.
  • Test locally with docker-compose -f docker-compose.yml -f docker-compose.local.yml up
  • Test locally ./scripts/chifra.sh blocks 12
  • Use the image in docker-compose.yaml (search for UPDATE_DOCKER_BUILD_VERSION)
  • Push, tag and make a release

Repos

  • trueblocks-core
  • trueblocks-docs
  • trueblocks-docker
  • trueblocks-tests
  • trueblocks-explorer
  • trueblocks-unchained
  • trueblocks-sen
  • trueblocks-snap
  • trueblocks-stack
Clone this wiki locally