Skip to content

Commit ee4445d

Browse files
lizkenyonclaude
andcommitted
Update REST_RESOURCES.md to document release candidate version convention
Old instructions referenced removed LATEST/RC constants from v15.0.0 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 212e2f5 commit ee4445d

1 file changed

Lines changed: 9 additions & 12 deletions

File tree

REST_RESOURCES.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,29 +9,27 @@ This guide provides step-by-step instructions for adding a new API version to th
99
## Step 1: Update API Version Constants
1010

1111
### Update admin_versions.rb
12-
Edit `lib/shopify_api/admin_versions.rb` to add your new version:
12+
Edit `lib/shopify_api/admin_versions.rb` to add your new version and the next upcoming release candidate:
1313

1414
```ruby
1515
module ShopifyAPI
1616
module AdminVersions
1717
SUPPORTED_ADMIN_VERSIONS = T.let([
1818
"unstable",
19-
"2025-10", # Add new version here
20-
"2025-07",
21-
"2025-04",
19+
"2026-07", # Next release candidate (always add the next quarterly version)
20+
"2026-04", # New version being added
21+
"2026-01",
2222
# ... other versions
2323
], T::Array[String])
24-
25-
LATEST_SUPPORTED_ADMIN_VERSION = T.let("2025-07", String) # Update if this is the latest stable
26-
RELEASE_CANDIDATE_ADMIN_VERSION = T.let("2025-10", String) # Update if this is RC
2724
end
2825
end
2926
```
3027

3128
**Version Management:**
32-
- Add new versions to the top of `SUPPORTED_ADMIN_VERSIONS`
33-
- Update `LATEST_SUPPORTED_ADMIN_VERSION` when the version is stable
34-
- Update `RELEASE_CANDIDATE_ADMIN_VERSION` for release candidates
29+
- Add new versions to the top of `SUPPORTED_ADMIN_VERSIONS` (below "unstable")
30+
- Also add the **next quarterly version** as the upcoming release candidate
31+
- Shopify API versions follow a quarterly cadence: 01, 04, 07, 10
32+
- For example, when adding 2026-04, also add 2026-07
3533

3634
## Step 2: Create Directory Structure
3735

@@ -147,8 +145,7 @@ bundle exec rake test TEST=test/rest/{NEW_VERSION}/*
147145
## Checklist
148146

149147
- [ ] Added new version to `SUPPORTED_ADMIN_VERSIONS` in `admin_versions.rb`
150-
- [ ] Updated `LATEST_SUPPORTED_ADMIN_VERSION` if applicable
151-
- [ ] Updated `RELEASE_CANDIDATE_ADMIN_VERSION` if applicable
148+
- [ ] Added next quarterly version as release candidate to `SUPPORTED_ADMIN_VERSIONS`
152149
- [ ] Created `lib/shopify_api/rest/resources/{NEW_VERSION}/` directory
153150
- [ ] Created `test/rest/{NEW_VERSION}/` directory
154151
- [ ] Copied all resource files from previous version

0 commit comments

Comments
 (0)