Skip to content

Commit f9c9e19

Browse files
authored
Merge pull request #497 from Shopify/andyw8/api-update-reminders
Add automated reminder for API updates
2 parents b54e60c + ab9b4b9 commit f9c9e19

File tree

4 files changed

+76
-0
lines changed

4 files changed

+76
-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: @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 now Stable API version, and aim to release an update of the library within one week.
25+
26+
Thank you!
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: A new release of the Shopify API occurred
3+
assignees: @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 was scheduled for today,
8+
so a new release of the library is now due.
9+
10+
A draft PR should already exist for this.
11+
12+
Review the changelog again and consider if anything in the library needs to change:
13+
14+
https://shopify.dev/changelog
15+
16+
Test against the new release by using the Stable version just releaesd
17+
18+
Aim to release an update of the library within one week.
19+
20+
Thank you!
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
on:
2+
schedule:
3+
- cron: "0 0 1 3,6,9,12 *" # At 00:00 on 1st of March, June, September, and December
4+
5+
name: API update reminder
6+
jobs:
7+
reminder:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: actions/checkout@v2
11+
- uses: JasonEtco/[email protected]
12+
env:
13+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
14+
with:
15+
filename: .github/api_update_reminder.md
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
on:
2+
schedule:
3+
- cron: "0 0 1 1,4,7,10 *" # At 00:00 on 1st of January, April, July, and October
4+
5+
name: API update reminder
6+
jobs:
7+
reminder:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: actions/checkout@v2
11+
- uses: JasonEtco/[email protected]
12+
env:
13+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
14+
with:
15+
filename: .github/api_update_reminder_on_release.md

0 commit comments

Comments
 (0)