Skip to content

Commit 8926a5c

Browse files
authored
Add GitHub settings and Renovate to init checklist (#388)
1 parent 8f17be6 commit 8926a5c

File tree

7 files changed

+47
-6
lines changed

7 files changed

+47
-6
lines changed

.changeset/young-chefs-begin.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'skuba': patch
3+
---
4+
5+
**template:** Add GitHub repository settings and Renovate to init checklist

template/express-rest-api/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,10 @@ Next steps:
1818
5. [ ] Add Datadog configuration and data classification tags to [.gantry/common.yml](.gantry/common.yml);
1919
see the [Gantry] documentation for more information.
2020
6. [ ] Push local commits to the upstream GitHub branch.
21-
7. [ ] Delete this checklist 😌.
21+
7. [ ] Configure [GitHub repository settings].
22+
8. [ ] Keep dependencies up to date with [Renovate];
23+
request installation in [SEEK-Jobs/renovate].
24+
9. [ ] Delete this checklist 😌.
2225

2326
## Table of contents
2427

@@ -115,4 +118,7 @@ TODO: add support links for the prod environment.
115118
[codex]: https://codex.ssod.skinfra.xyz/docs
116119
[express]: https://expressjs.com
117120
[gantry]: https://gantry.ssod.skinfra.xyz
121+
[github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
122+
[renovate]: https://github.com/apps/renovate
123+
[seek-jobs/renovate]: https://github.com/SEEK-Jobs/renovate
118124
[technology strategy]: https://tech-strategy.ssod.skinfra.xyz

template/greeter/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,10 @@ Next steps:
1616
4. [ ] Fill out [.me](.me) to power SEEK's system catalogue;
1717
see the [Codex] documentation for more information.
1818
5. [ ] Push local commits to the upstream GitHub branch.
19-
6. [ ] Delete this checklist 😌.
19+
6. [ ] Configure [GitHub repository settings].
20+
7. [ ] Keep dependencies up to date with [Renovate];
21+
request installation in [SEEK-Jobs/renovate].
22+
8. [ ] Delete this checklist 😌.
2023

2124
## Table of contents
2225

@@ -105,4 +108,7 @@ TODO: add support links for the prod environment.
105108

106109
[builds at seek]: https://builds-at-seek.ssod.skinfra.xyz
107110
[codex]: https://codex.ssod.skinfra.xyz/docs
111+
[github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
112+
[renovate]: https://github.com/apps/renovate
113+
[seek-jobs/renovate]: https://github.com/SEEK-Jobs/renovate
108114
[technology strategy]: https://tech-strategy.ssod.skinfra.xyz

template/koa-rest-api/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,10 @@ Next steps:
1818
5. [ ] Add Datadog configuration and data classification tags to [.gantry/common.yml](.gantry/common.yml);
1919
see the [Gantry] documentation for more information.
2020
6. [ ] Push local commits to the upstream GitHub branch.
21-
7. [ ] Delete this checklist 😌.
21+
7. [ ] Configure [GitHub repository settings].
22+
8. [ ] Keep dependencies up to date with [Renovate];
23+
request installation in [SEEK-Jobs/renovate].
24+
9. [ ] Delete this checklist 😌.
2225

2326
## Table of contents
2427

@@ -119,5 +122,8 @@ TODO: add support links for the prod environment.
119122
[codedeploy]: https://docs.aws.amazon.com/codedeploy
120123
[codex]: https://codex.ssod.skinfra.xyz/docs
121124
[gantry]: https://gantry.ssod.skinfra.xyz
125+
[github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
122126
[koa]: https://koajs.com
127+
[renovate]: https://github.com/apps/renovate
128+
[seek-jobs/renovate]: https://github.com/SEEK-Jobs/renovate
123129
[technology strategy]: https://tech-strategy.ssod.skinfra.xyz

template/lambda-sqs-worker/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,10 @@ Next steps:
1717
see the [Codex] documentation for more information.
1818
5. [ ] Add deployment bucket configuration and data classification tags to [serverless.yml](serverless.yml).
1919
6. [ ] Push local commits to the upstream GitHub branch.
20-
7. [ ] Delete this checklist 😌.
20+
7. [ ] Configure [GitHub repository settings].
21+
8. [ ] Keep dependencies up to date with [Renovate];
22+
request installation in [SEEK-Jobs/renovate].
23+
9. [ ] Delete this checklist 😌.
2124

2225
## Table of contents
2326

@@ -139,6 +142,9 @@ TODO: add support links for the prod environment.
139142
[builds at seek]: https://builds-at-seek.ssod.skinfra.xyz
140143
[codedeploy]: https://docs.aws.amazon.com/codedeploy
141144
[codex]: https://codex.ssod.skinfra.xyz/docs
145+
[github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
142146
[lambda]: https://docs.aws.amazon.com/lambda
147+
[renovate]: https://github.com/apps/renovate
148+
[seek-jobs/renovate]: https://github.com/SEEK-Jobs/renovate
143149
[serverless]: https://www.serverless.com/
144150
[technology strategy]: https://tech-strategy.ssod.skinfra.xyz

template/oss-npm-package/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,10 @@ Next steps:
1313
3. [ ] Fill out [.me](.me) to power SEEK's system catalogue;
1414
see the [Codex] documentation for more information.
1515
4. [ ] Push local commits to the upstream GitHub branch.
16-
5. [ ] Delete this checklist 😌.
16+
5. [ ] Configure [GitHub repository settings].
17+
6. [ ] Keep dependencies up to date with [Renovate];
18+
request installation in [#open-source].
19+
7. [ ] Delete this checklist 😌.
1720

1821
## Table of contents
1922

@@ -121,11 +124,14 @@ Here are some branches that **semantic-release** supports by default:
121124

122125
For more information, see the **semantic-release** docs on [triggering a release].
123126

127+
[#open-source]: https://slack.com/app_redirect?channel=C39P1H2SU
124128
[codex]: https://codex.ssod.skinfra.xyz/docs
125129
[distribution tags]: https://docs.npmjs.com/adding-dist-tags-to-packages
126130
[oss npm package guidance]: https://github.com/SEEK-Jobs/seek-oss-ci/blob/master/NPM_PACKAGES.md#access-to-publish-to-npm
127131
[release workflow]: .github/workflows/release.yml
128132
[seek-oss]: https://github.com/seek-oss
133+
[github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
129134
[seek's open source rfc]: https://rfc.skinfra.xyz/RFC016-Open-Source.html
135+
[renovate]: https://github.com/apps/renovate
130136
[semantic-release]: https://github.com/semantic-release/semantic-release
131137
[triggering a release]: https://github.com/semantic-release/semantic-release/#triggering-a-release

template/private-npm-package/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,10 @@ Next steps:
1313
3. [ ] Fill out [.me](.me) to power SEEK's system catalogue;
1414
see the [Codex] documentation for more information.
1515
4. [ ] Push local commits to the upstream GitHub branch.
16-
5. [ ] Delete this checklist 😌.
16+
5. [ ] Configure [GitHub repository settings].
17+
6. [ ] Keep dependencies up to date with [Renovate];
18+
request installation in [SEEK-Jobs/renovate].
19+
7. [ ] Delete this checklist 😌.
1720

1821
## Table of contents
1922

@@ -109,8 +112,11 @@ For more information, see the **semantic-release** docs on [triggering a release
109112

110113
[codex]: https://codex.ssod.skinfra.xyz/docs
111114
[distribution tags]: https://docs.npmjs.com/adding-dist-tags-to-packages
115+
[github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
112116
[gutenberg]: https://github.com/SEEK-Jobs/gutenberg
113117
[installing on your repository]: https://github.com/SEEK-Jobs/gutenberg#installing-on-your-repository
118+
[renovate]: https://github.com/apps/renovate
114119
[seek-jobs]: https://github.com/orgs/seek-jobs/sso
120+
[seek-jobs/renovate]: https://github.com/SEEK-Jobs/renovate
115121
[semantic-release]: https://github.com/semantic-release/semantic-release
116122
[triggering a release]: https://github.com/semantic-release/semantic-release/#triggering-a-release

0 commit comments

Comments
 (0)