Couchbase Lite Documentation

Source File Location

The documentation for each SDK is kept in a single AsciiDoc file:

• Swift | swift.adoc

• Java | java-jvm.adoc

• Java (Android) | java-android.adoc

• C# | csharp.adoc

• Objective-C | objc.adoc

Release Notes

Tasks to prepare release notes (the process is the same on all platforms):

1. Copy the "Bugs" and "Known Issues" list from raw.html to the SDK’s Source File Location under the == Release Notes heading. Example: 24ba5e5

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 [email protected]:couchbase/docs-couchbase-lite.git cbl-x.y
   cd cbl-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: 6171d62

4. Update your local playbook. Example:

     ...
   - url: ./../sg/sg-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:

Swift

1. Create new branch.

2. Bump :version: attribute in swift.adoc. Example: 939c8a2

3. Prepare Release Notes.

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

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

Java

1. Create new branch.

2. Bump :version: attribute java-jvm.adoc. Example: deefb02

3. Prepare Release Notes.

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

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

Java (Android)

1. Create new branch.

2. Bump :version: attribute java-android.adoc. Example: deefb02

3. Prepare Release Notes.

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

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

C#

1. Create new branch.

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).

Objective-C

1. Create new branch.

2. Bump :version: attribute objc.adoc. Example: f69119f

3. Prepare Release Notes.

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

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