README.adoc

Sync Gateway Documentation

Release Notes

Tasks to prepare release notes:

1. Copy the "Bugs" and "Known Issues" list from raw.html to release-notes.adoc under the == Release Notes heading. Example: 1a5b784

2. Review the issue summaries.

3. Commit on the release branch.

4. Push to GitHub.

Release Tasks

Minor Release

Tasks for a minor release (x.y):

1. Clone repository

   # replace *x.y* accordingly
   git clone git@github.com:couchbase/docs-sync-gateway.git sg-x.y
   cd sg-x.y

2. Create new branch release/x.y and push to GitHub.

   git checkout -b release/x.y
   git push

3. Update metadata version. Example: 42d68f0

4. Update your local playbook. Example:

     ...
   - url: ./../cbl/cbl-x.y
     branches: HEAD

5. Verify it builds locally

6. Update staging playbook. Example: 2d40527

7. Update production playbook. Example: 65958c9

8. Mark release/x.y as default branch on GitHub.

Patch Release

Tasks for a patch release:

1. Update download link attributes getting-started.adoc. Example: f495d23

2. Prepare Release Notes.

3. Open PR when there is code freeze for the release (tracked on JIRA).

4. Merge PR when the release is being published (tracked on JIRA).