Publishing a Release
note
The items under Pre-release testing and Post-release activities still need to be automated.
Pre-release testing
Starter testing
Test new release with current version of all starters in gitlab:adpt/starters.
The
hello-react-node-postgres
starter is fairly well tested by the getting started doc testing.The
hello-node
starter is fairly well tested by the tutorial doc testing.So for remaining starters:
adapt new <starter> ./test
cd ./test/deploy
adapt run
- Check results
Build, test, and publish
important
Make sure you are logged into GitLab before clicking any of the links below.
(They give 404 errors if you're not logged in.)
next
Release (master branch)
This will create a public release of the master branch and give it the NPM dist-tag
of next
.
Major or Minor Release (master branch)
This will create a public release of the master branch and give it the NPM dist-tag
of latest
.
Patch Release (release branch)
warning
Right now, there's no way to specify that these releases do not get the dist-tag
of latest
.
So if you're publishing a patch release from an older release, you'll need to either fix that or adjust the dist-tag
s manually afterward.
note
Release branch names only contain the major and minor version numbers.
Go to the Run Pipeline page for Adapt.
Select the release branch for the correct release (
release-X.Y
)Double check that the environment variable
ADAPT_RELEASE_TYPE
is set topatch
.Click
Run Pipeline
.
Development Release (from any other branch)
important
Please only create a development release when absolutely necessary.
Go to the Run Pipeline page for Adapt.
Select the development branch you wish to publish.
Double check that the environment variable
ADAPT_RELEASE_TYPE
is set todev
.Click
Run Pipeline
.
Post-release activities
Version documentation
For major, minor, and patch releases, you'll need to create a new version of the docs:
First, ensure you have no uncommitted files in either
adapt
oradapt-web
From the
adapt
repo:git status pushd web/website git status popd
Update and build both the
adapt
andadapt-web
reposnote
Set
REL_VER
to the version that you just built.From the
adapt
repo:REL_VER=1.1.1 pushd web/website git checkout master git pull --ff-only popd git fetch origin git checkout v${REL_VER} make web-build
Create the new version in
adapt-web
From the
adapt
repo:cd web/website yarn run version ${REL_VER}
Confirm default version is correct
The most recently created doc version will be listed first in
adapt/web/website/versions.json
and will therefore be the default documentation version for the site. Typically, the most recent stable version should be the default. If necessary, change the ordering inversions.json
to put the correct default version first.Start the preview server
cd .. make preview
Review site
Particularly check http://localhost:3000/versions. Edit
web/website/pages/en/versions.js
as needed.Commit and push
From
adapt/web
:git add . git commit -m "Creating versioned docs for ${REL_VER}" git push origin