DX | 01-06-2026 | Release

.github/workflows/back-merge-pr.yml

@@ -0,0 +1,54 @@
+name: Back-merge master to development
+
+on:
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  open-back-merge-pr:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Open back-merge PR if needed
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          set -euo pipefail
+          BASE_BRANCH="development"
+          SOURCE_BRANCH="master"
+
+          git fetch origin "$BASE_BRANCH" "$SOURCE_BRANCH"
+
+          if ! git show-ref --verify --quiet "refs/remotes/origin/$BASE_BRANCH"; then
+            echo "Base branch '$BASE_BRANCH' does not exist on origin; skipping."
+            exit 0
+          fi
+
+          SOURCE_SHA=$(git rev-parse "origin/$SOURCE_BRANCH")
+          BASE_SHA=$(git rev-parse "origin/$BASE_BRANCH")
+
+          if [ "$SOURCE_SHA" = "$BASE_SHA" ]; then
+            echo "$SOURCE_BRANCH and $BASE_BRANCH are at the same commit; nothing to back-merge."
+            exit 0
+          fi
+
+          EXISTING=$(gh pr list --repo "${{ github.repository }}"             --base "$BASE_BRANCH"             --head "$SOURCE_BRANCH"             --state open             --json number             --jq 'length')
+
+          if [ "$EXISTING" -gt 0 ]; then
+            echo "An open PR from $SOURCE_BRANCH to $BASE_BRANCH already exists; skipping."
+            exit 0
+          fi
+
+          gh pr create --repo "${{ github.repository }}"             --base "$BASE_BRANCH"             --head "$SOURCE_BRANCH"             --title "chore: back-merge $SOURCE_BRANCH into $BASE_BRANCH"             --body "Automated back-merge after changes landed on \\`$SOURCE_BRANCH\\`. Review and merge to keep \\`$BASE_BRANCH\\` in sync."
+
+          echo "Created back-merge PR $SOURCE_BRANCH -> $BASE_BRANCH."

.github/workflows/check-version-bump.yml

@@ -0,0 +1,79 @@
+name: Check Version Bump
+
+on:
+  pull_request:
+
+jobs:
+  version-bump:
+    name: Version & Changelog bump
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Detect changed files and version bump
+        id: detect
+        run: |
+          if git rev-parse HEAD^2 >/dev/null 2>&1; then
+            FILES=$(git diff --name-only HEAD^1 HEAD^2)
+          else
+            FILES=$(git diff --name-only HEAD~1 HEAD)
+          fi
+          VERSION_FILES_CHANGED=false
+          echo "$FILES" | grep -qx 'lib/contentstack/version.rb' && VERSION_FILES_CHANGED=true
+          echo "$FILES" | grep -qx 'CHANGELOG.md' && VERSION_FILES_CHANGED=true
+          echo "version_files_changed=$VERSION_FILES_CHANGED" >> $GITHUB_OUTPUT
+          # Only lib/ counts as release-affecting; .github/ and spec/ do not
+          CODE_CHANGED=false
+          echo "$FILES" | grep -qE '^lib/' && CODE_CHANGED=true
+          echo "code_changed=$CODE_CHANGED" >> $GITHUB_OUTPUT
+
+      - name: Skip when only test/docs/.github changed
+        if: steps.detect.outputs.code_changed != 'true'
+        run: |
+          echo "No release-affecting files changed (e.g. only spec/docs/.github). Skipping version-bump check."
+          exit 0
+
+      - name: Fail when version bump was missed
+        if: steps.detect.outputs.code_changed == 'true' && steps.detect.outputs.version_files_changed != 'true'
+        run: |
+          echo "::error::This PR has code changes but no version bump. Please bump the version in lib/contentstack/version.rb and add an entry in CHANGELOG.md."
+          exit 1
+
+      - name: Check version bump
+        if: steps.detect.outputs.code_changed == 'true' && steps.detect.outputs.version_files_changed == 'true'
+        run: |
+          set -e
+          GEM_VERSION=$(sed -n 's/.*VERSION = "\(.*\)".*/\1/p' lib/contentstack/version.rb)
+          if [ -z "$GEM_VERSION" ]; then
+            echo "::error::Could not read version from lib/contentstack/version.rb"
+            exit 1
+          fi
+          git fetch --tags --force 2>/dev/null || true
+          LATEST_TAG=$(git describe --tags --abbrev=0 2>/dev/null || true)
+          if [ -z "$LATEST_TAG" ]; then
+            echo "No existing tags found. Skipping version-bump check (first release)."
+            exit 0
+          fi
+          LATEST_VERSION="${LATEST_TAG#v}"
+          LATEST_VERSION="${LATEST_VERSION%%-*}"
+          if [ "$(printf '%s\n' "$LATEST_VERSION" "$GEM_VERSION" | sort -V | tail -1)" != "$GEM_VERSION" ]; then
+            echo "::error::Version bump required: lib/contentstack/version.rb ($GEM_VERSION) is not greater than latest tag ($LATEST_TAG). Please bump Contentstack::VERSION."
+            exit 1
+          fi
+          if [ "$GEM_VERSION" = "$LATEST_VERSION" ]; then
+            echo "::error::Version bump required: lib/contentstack/version.rb ($GEM_VERSION) equals latest tag ($LATEST_TAG). Please bump Contentstack::VERSION."
+            exit 1
+          fi
+          CHANGELOG_VERSION=$(sed -nE 's/^## Version ([0-9]+\.[0-9]+\.[0-9]+).*/\1/p' CHANGELOG.md | head -1)
+          if [ -z "$CHANGELOG_VERSION" ]; then
+            echo "::error::Could not find a version entry in CHANGELOG.md (expected line like '## Version 1.0.0')."
+            exit 1
+          fi
+          if [ "$CHANGELOG_VERSION" != "$GEM_VERSION" ]; then
+            echo "::error::CHANGELOG version mismatch: CHANGELOG.md top version ($CHANGELOG_VERSION) does not match lib/contentstack/version.rb ($GEM_VERSION). Please add or update the CHANGELOG entry for $GEM_VERSION."
+            exit 1
+          fi
+          echo "Version bump check passed: lib/contentstack/version.rb and CHANGELOG.md are at $GEM_VERSION (latest tag: $LATEST_TAG)."

.gitignore

@@ -4,6 +4,7 @@ test
 doc
 spec-integration
 coverage
+spec/.env.test
 \.yardoc
 .DS_Store
 .bundle/

CHANGELOG.md

@@ -1,5 +1,10 @@
 ## CHANGELOG
 
+## Version 0.8.5
+### Date: 5th-June-2026
+ ### Deprecated
+ - `Query#include_draft` is deprecated. The Content Delivery API returns published content only; the `include_draft` query parameter has no effect. Use Live Preview with the Preview Service to preview unpublished entries, or the Content Management API to work with draft content.
+
 ## Version 0.8.4
 ### Date: 15th-April-2026
  ### Security and Compatibility

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    contentstack (0.8.4)
+    contentstack (0.8.5)
       activesupport (>= 3.2)
       contentstack_utils (~> 1.2)
 
@@ -39,12 +39,12 @@ GEM
     hashdiff (1.2.1)
     i18n (1.14.8)
       concurrent-ruby (~> 1.0)
-    json (2.19.4)
+    json (2.19.5)
     logger (1.7.0)
-    minitest (6.0.5)
+    minitest (6.0.6)
       drb (~> 2.0)
       prism (~> 1.5)
-    nokogiri (1.19.2-arm64-darwin)
+    nokogiri (1.19.3-arm64-darwin)
       racc (~> 1.4)
     prism (1.9.0)
     public_suffix (7.0.5)
@@ -77,7 +77,7 @@ GEM
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    yard (0.9.43)
+    yard (0.9.44)
 
 PLATFORMS
   arm64-darwin-22

lib/contentstack/query.rb

@@ -565,16 +565,19 @@ def include_embedded_items()
       self
     end
 
-    # Include objects in 'Draft' mode in response
-    #
-    # Example
-    #
-    #    @query = @stack.content_type('product').query
-    #    @query.include_draft
-    #
-    # @return [Contentstack::Query]
-    def include_draft(flag=true)
-      @query[:include_draft] = flag
+    # @deprecated since 0.8.5 The Content Delivery API returns published content only.
+    #   Unpublished or draft entries are not available through CDA queries. Use Live Preview
+    #   with the Preview Service, or the Content Management API, to access unpublished content.
+    #
+    # @return [Contentstack::Query]
+    def include_draft(_flag=true)
+      warn(
+        "Contentstack: Query#include_draft is deprecated and has no effect on the Content " \
+        "Delivery API, which returns published content only. To preview unpublished entries, " \
+        "use Live Preview with the Preview Service. To manage or fetch draft entries, use " \
+        "the Content Management API.",
+        uplevel: 1
+      )
       self
     end
 

lib/contentstack/version.rb

@@ -1,3 +1,3 @@
 module Contentstack
-  VERSION = "0.8.4"
+  VERSION = "0.8.5"
 end

skills/code-review/SKILL.md

@@ -32,7 +32,7 @@ description: Use when authoring or reviewing a pull request for contentstack-rub
 
 ### Process notes
 
-- **`master`** is protected by **`.github/workflows/check-branch.yml`**; follow team flow (**`staging`** → **`master`**) for production promotion.
+- Follow direct release flow **`development` -> `master`** (no `staging` handoff in the release path).
 - Run **`bundle exec rspec`** locally; CI may not run the full suite on every PR in this repository.
 
 ## References

skills/dev-workflow/SKILL.md

@@ -28,7 +28,7 @@ description: Use when setting up the repo, running tests or docs, choosing branc
 
 ### Branches and PRs
 
-- Default integration branch is typically **`development`** (confirm on GitHub). **`master`** merges are restricted: `.github/workflows/check-branch.yml` blocks PRs into `master` unless the head branch is **`staging`**—follow org process for promotion.
+- Default integration branch is typically **`development`** (confirm on GitHub). Release PRs go directly **`development` -> `master`**; `staging` is not part of the release promotion flow.
 - Keep PRs focused; mention breaking API or Ruby version requirement changes in the description.
 
 ### Before you push

skills/testing/SKILL.md

@@ -30,7 +30,7 @@ description: Use when writing or fixing RSpec examples, WebMock stubs, JSON fixt
 
 ### Helpers
 
-- **`create_client`** and **`create_preview_client`** in **`spec_helper`** build clients using **`ENV['API_KEY']`**, **`ENV['DELIVERY_TOKEN']`**, **`ENV['ENVIRONMENT']`** — tests should not rely on real credentials; stubs supply responses.
+- **`create_client`** and **`create_preview_client`** in **`spec_helper`** build clients using **`ENV['API_KEY']`**, **`ENV['DELIVERY_TOKEN']`**, **`ENV['ENVIRONMENT']`**. Copy **`spec/.env.test.example`** to **`spec/.env.test`** (gitignored) for local runs without exporting env vars; CLI/env values already set take precedence. Tests use WebMock stubs and do not require live API calls.
 
 ### Coverage
 

spec/.env.test.example

@@ -0,0 +1,10 @@
+# Copy to spec/.env.test and fill in your stack credentials.
+# spec/.env.test is gitignored — do not commit real tokens.
+#
+# bundle exec rspec
+
+API_KEY=your_stack_api_key
+DELIVERY_TOKEN=your_delivery_token
+ENVIRONMENT=development
+# Optional: only needed for custom CDN host tests
+# HOST=cdn.contentstack.io

spec/query_spec.rb

@@ -165,8 +165,13 @@
     expect(data.first.fields[:locale]).not_to be nil
   end
 
-  it "should get data using `include_draft` method" do
-    data = category_query.include_draft.fetch
+  it "warns when `include_draft` is called and does not send include_draft to the API" do
+    query = category_query
+    expect {
+      query.include_draft
+    }.to output(/Query#include_draft is deprecated/).to_stderr
+    expect(query.query).not_to have_key(:include_draft)
+    data = query.fetch
     expect(data.length).to eq 5
   end
 

spec/spec_helper.rb

@@ -16,6 +16,8 @@
 require 'webmock/rspec'
 WebMock.disable_net_connect!(allow_localhost: true)
 
+require_relative 'support/load_test_env'
+
 require 'simplecov'
 SimpleCov.start
 

spec/support/load_test_env.rb

@@ -0,0 +1,23 @@
+# Loads optional local test credentials from spec/.env.test (gitignored).
+# Existing ENV values are not overwritten, so CLI exports still take precedence.
+module ContentstackTestEnv
+  ENV_FILE = File.expand_path("../.env.test", __dir__).freeze
+
+  def self.load!
+    return unless File.file?(ENV_FILE)
+
+    File.foreach(ENV_FILE) do |line|
+      line = line.strip
+      next if line.empty? || line.start_with?("#")
+
+      key, value = line.split("=", 2)
+      next if key.nil? || value.nil?
+
+      key = key.strip
+      value = value.strip.delete_prefix('"').delete_suffix('"')
+      ENV[key] = value unless ENV.key?(key) && !ENV[key].to_s.empty?
+    end
+  end
+end
+
+ContentstackTestEnv.load!