Skip to content

Commit ae54eb7

Browse files
committed
Add automated reminder for API updates
1 parent 4636b1d commit ae54eb7

File tree

2 files changed

+42
-0
lines changed

2 files changed

+42
-0
lines changed

.github/api_update_reminder.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: A new release of the Shopify API is due soon
3+
assignees: andyw8 # @platform/dev-tools-education
4+
labels: automated
5+
---
6+
7+
This is an automated reminder for the maintainers that a new Stable release of the Shopify API is due soon, so the library needs to be updated.
8+
9+
A new library release should be prepared to:
10+
* add the upcoming Stable release
11+
* remove the oldest Stable release which will no longer be supported.
12+
13+
The PR should be created as a **draft** but not yet be merged.
14+
15+
The release schedule can be found at https://shopify.dev/concepts/about-apis/versioning
16+
17+
Review the changelog and consider if anything in the library needs to change:
18+
19+
https://shopify.dev/changelog
20+
21+
Test against the upcoming release by using the Release Candidate.
22+
23+
Another reminder issue will be created on the date of the next release.
24+
When that happens, test again using the Stable API version, and aim to release an update of the library within one week.
25+
26+
Thank you!
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
on:
2+
workflow_dispatch: # to allow for manual testing
3+
# schedule:
4+
# - cron: "0 0 1 3,6,9,12 *" # At 00:00 on 1st of March, June, September, and December
5+
6+
name: API update reminder
7+
jobs:
8+
reminder:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v2
12+
- uses: JasonEtco/[email protected]
13+
env:
14+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
15+
with:
16+
filename: .github/api_update_reminder.md

0 commit comments

Comments
 (0)