We are committed to release every quarter in order to have a constant and predictable cadence for our deliverables.
For more information, check out our Release Policy page.
Detailed list of steps for the release
Here are the steps to follow to release a new minor version.
They are written in the order required to make the process work. However, some material required for the release should be prepared before starting with those steps, like the text of the upgrade guide or the messages to send to the community.
Release preparation
[x] Be sure there are no pending PRs that you want to include in the next minor.
[x] Run the Prepare Release Workflow, leaving main as the branch and the checkbox to prepare the next major unchecked (unless necessary).
[x] A new auto-generated PR will appear; be sure everything looks good and merge it.
More details about the release workflows are described on our
Release pipeline automation wiki page,
which we encourage to review if the assignee is not familiar with the topic.
Release the Solidus gems on Rubygems
To officially release the Solidus gems, you need to have permissions on RubyGems, with 2FA enabled.
Open Solidus on your local machine and run:
git checkout main
git pull
gem release
You will be prompted to enter your 2FA code multiple times, one for each solidus' subgems.
[x] Release on RubyGems done!
After-release Chores
Now that Solidus has been released, we need to cleanup the main branch to get ready for
the next release. As you may have noticed, when the "Release Preparation" PR has been merged,
a new PR has been automatically created. That PR already contains the code to get our repository
clean and ready.
New minor release of Solidus
We are committed to release every quarter in order to have a constant and predictable cadence for our deliverables.
For more information, check out our Release Policy page.
Detailed list of steps for the release
Here are the steps to follow to release a new minor version.
They are written in the order required to make the process work. However, some material required for the release should be prepared before starting with those steps, like the text of the upgrade guide or the messages to send to the community.
Release preparation
main
as the branch and the checkbox to prepare the next major unchecked (unless necessary).More details about the release workflows are described on our Release pipeline automation wiki page, which we encourage to review if the assignee is not familiar with the topic.
Release the Solidus gems on Rubygems
To officially release the Solidus gems, you need to have permissions on RubyGems, with 2FA enabled.
Open Solidus on your local machine and run:
You will be prompted to enter your 2FA code multiple times, one for each solidus' subgems.
After-release Chores
Now that Solidus has been released, we need to cleanup the
main
branch to get ready for the next release. As you may have noticed, when the "Release Preparation" PR has been merged, a new PR has been automatically created. That PR already contains the code to get our repository clean and ready.Steps to do outside the main repository
npm run docusaurus docs:version X.Y
). https://github.com/solidusio/edgeguides/commit/3725930a6b918c0032eeb64a5d98800fc91d4419v3.3
) https://github.com/solidusio/solidus_starter_frontend/tree/v4.1v3.3
), change the default solidus target branch in the CircleCI Config to point to the newly created branch. https://github.com/solidusio/solidus_starter_frontend/commit/b9b9dc62e25e9624b5661ae03678f8281f49ee91v3.3
).