Giter Club home page Giter Club logo

docs-couchbase-lite's Introduction

Couchbase Lite Documentation

Source File Location

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

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.