Roll out `changelog_api` feature flag
What
Roll out the API that allows users to generate changelogs using the GitLab API.
Owners
- Team: Delivery
- Most appropriate slack channel to reach out to:
#g_delivery
- Best individual to reach out to: @yorickpeterse
Expectations
We will start testing this on Release Tools. We expect a few small bugs here and there (e.g. formatting not being quite right), but nothing too serious.
What are we expecting to happen?
See above
What might happen if this goes wrong?
An incorrect changelog is generated on the projects that we're using for testing purposes (e.g. commits may not be included).
What can we monitor to detect problems with this?
This requires that we manually keep an eye on things, as there's not way of automatically detecting issues.
Beta groups/projects
- gitlab-org/release-tools
Roll Out Steps
-
Enable on staging ( /chatops run feature set changelog_api true --staging --project yorickpeterse/testing
) -
Test on staging -
Ensure that documentation has been updated -
Enable on GitLab.com for individual groups/projects listed above and verify behaviour ( /chatops run feature set --project=gitlab-org/release-tools changelog_api true
) -
Coordinate a time to enable the flag with the SRE oncall and release managers - In
#production
mention@sre-oncall
and@release-managers
. Once an SRE on call and Release Manager on call confirm, you can proceed with the rollout
- In
-
Announce on the issue an estimated time this will be enabled on GitLab.com -
Enable on GitLab.com by running chatops command in #production
(/chatops run feature set changelog_api true
) -
Cross post chatops Slack command to #support_gitlab-com
(more guidance when this is necessary in the dev docs) and in your team channel -
Announce on the issue that the flag has been enabled -
Remove feature flag and add changelog entry -
After the flag removal is deployed, clean up the feature flag by running chatops command in #production
channel
Rollback Steps
-
This feature can be disabled by running the following Chatops command:
/chatops run feature set changelog_api false
Edited by Yorick Peterse