Skip to content

CDRIVER-5529 update release instructions to account for new rulesets #1997

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 23, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/dev/releasing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ MongoDB C driver library. The release includes the following steps:
.. _evg-release: https://spruce.mongodb.com/commits/mongo-c-driver-latest-release
.. _evg-release-settings: https://spruce.mongodb.com/project/mongo-c-driver-latest-release/settings/general
.. _snyk: https://app.snyk.io
.. _dbx-c-cxx-releases-github: https://github.com/orgs/mongodb/teams/dbx-c-cxx-releases/
.. _dbx-c-cxx-releases-mana: https://mana.corp.mongodb.com/resources/68029673d39aa9f7de6399f9

.. rubric:: Checklist Form

Expand Down Expand Up @@ -250,6 +252,20 @@ __ https://github.com/settings/tokens
(Selecting this permission may also enable the *Metadata* permission; this is
normal.)

Join the Release Team
#####################

The release process may require creating new branches, new tags, and directly
pushing to development branches. These operations are normally restricted by
branch protection rules.

When assigned the responsibility of performing a release, submit a request to a
repository administrator to be temporarily added to the
`releases team <dbx-c-cxx-releases-github_>`_ on GitHub for the duration of the
release process. The team member must be added via
`MANA <dbx-c-cxx-releases-mana_>`_ (the GitHub team should normally be empty,
meaning there should not be any member with the "Maintainer" role to add new
users via GitHub).

Do the Release
##############
Expand Down Expand Up @@ -486,6 +502,13 @@ changes back into the ``master`` branch.
__ https://github.com/mongodb/mongo-c-driver/pulls


Leave the Release Team
**********************

Remove yourself from the `releases team <dbx-c-cxx-releases-github_>`_ on GitHub
via `MANA <dbx-c-cxx-releases-mana_>`_.


.. _releasing.jira:

Close the Jira Release Ticket and Finish the Jira Release
Expand Down