# protobuf

**Repository Path**: mirrors_cockroachdb/protobuf

## Basic Information

- **Project Name**: protobuf
- **Description**: Protocol Buffers - Google's data interchange format
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2025-06-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# cockroachdb/protobuf

This repository is [CockroachDB]'s fork of [Protocol Buffers], Google's
language-neutral, platform-neutral, extensible mechanism for serializing
structured data.

It exists for two reasons: to provide a home for CockroachDB-specific patches,
as necessary, and to ensure that the Protocol Buffers submodule in
[cockroachdb/cockroach][cockroachdb] has a company-controlled remote to point
at.

It is critical that any commit in this repository that is referenced from
[cockroachdb/cockroach][cockroachdb] remains available here in perpetuity. For
every referenced commit, there must be at least one named branch or tag here
that has the commit as an ancestor, or else the commit will be garbage collected
by GitHub.

**To add a patch to an existing release branch:**

  1. In your [cockroachdb/cockroach][cockroachdb] clone, change into the
     submodule's directory, `c-deps/protobuf`:

     ```shell
     $ cd $GOPATH/src/github.com/cockroachdb/cockroach
     $ cd c-deps/protobuf
     ```

  2. Create a feature branch named after yourself, like `tschottdorf/nullable`.

  3. Commit your patch.

  4. Push your changes to the named feature branch. External contributors
     will need to fork this repository and push to their fork instead.

  5. Make a commit in [cockroachdb/cockroach][cockroachdb] that updates the
     submodule ref.

     ```shell
     $ cd $GOPATH/src/github.com/cockroachdb/cockroach
     $ git add c-deps/protobuf
     $ git commit -m "protobuf: upgrade to..."
     ```

  6. Open a pull request against [cockroachdb/cockroach][cockroachdb] and wait
     for review.

  7. *Before* your downstream PR has merged but after it has been LGTM'd and
     passed tests, push your changes to the release branch in this repository.
     You do not need to open a PR against this repository directly; the review
     of your downstream PR suffices.

     ```shell
     $ git checkout crl-release-X.X
     $ git merge --ff-only FEATURE-BRANCH
     $ git push origin crl-release-X.X
     ```

     **Important:** don't force push! If your push is rejected, either someone
     else merged an intervening change or you didn't base your feature branch
     off the tip of the release branch. Rebase your feature branch, update your
     downstream PR with the new commit SHA, and verify tests still pass. Then
     try your push again.

  8. From the GitHub web UI, verify that the exact submodule SHA that landed in
     [cockroachdb/cockroach][cockroachdb] is on the appropriate release branch.
     If it is, delete your feature branch.

     ```shell
     $ git push -d origin FEATURE-BRANCH
     ```

**To create a new release branch:**

  1. Follow step one above.

  2. Add an upstream remote and fetch from it.

     ```shell
     $ git remote add upstream https://github.com/google/protobuf
     $ git fetch upstream
     ```

  3. Create and push a new branch with the desired start point:

     ```shell
     $ git checkout -b crl-release-X.X upstream/RELEASE-BRANCH
     $ git push origin crl-release-X.X
     ```

  4. Protect the branch from force-pushes in the repository settings. This is
     crucial in ensuring that we don't break commit references in
     [cockroachdb/cockroach][cockroachdb]'s submodules.

  5. Follow steps three through six above.

[CockroachDB]: https://github.com/cockroachdb/cockroach
[Protocol Buffers]: https://github.com/google/protobuf