Deploying

Important

All the deployments below can be triggered from Bitbucket pipelines.

But only admins may release new versions.

You should trigger the builds as documented but the builds will halt until an Admin allows them to continue.

Documentation Only

To deploy changes to the documentation only:

1. Create a branch named release/documentation from the latest commit on main
2. Create a feature branch from this branch with a relevant name (prefixed feature/)
3. Perform changes to your documentation.
4. Create a PR from your feature branch into release/documentation
5. Once approved, merge it. Repeat for however many documentation feature branches needed.
6. Run the from Bitbucket Pipelines
7. Once done, merge release/documentation into develop and main
8. Delete release/documentation

Deploying the Ruby Gems

Please follow standard GitFlow for creating releases: https://datasift.github.io/gitflow/IntroducingGitFlow.html

1. Follow standard GitFlow practices for feature branches and release branches.
2. Once you have your release branch, bump relevant Gem versions. (Versioning)
3. Trigger the deployment

4. If you don't need to touch the core apadmi_grout module you can just update the fastlane plugin.

   

5. Otherwise deploy both Gems.

   

Note

By deploying both gems, or deploying fastlane, this will automatically deploy the documentation.