skuba 4.3.0 → 4.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (21) hide show
  1. package/README.md +1 -1
  2. package/lib/api/jest/index.d.ts +19 -19
  3. package/lib/cli/test/reporters/github/annotations.js +4 -1
  4. package/lib/cli/test/reporters/github/annotations.js.map +1 -1
  5. package/lib/utils/args.d.ts +1 -1
  6. package/package.json +38 -12
  7. package/template/express-rest-api/.buildkite/pipeline.yml +4 -4
  8. package/template/express-rest-api/.gantry/common.yml +1 -1
  9. package/template/express-rest-api/README.md +3 -7
  10. package/template/greeter/.buildkite/pipeline.yml +1 -1
  11. package/template/greeter/README.md +4 -8
  12. package/template/koa-rest-api/.buildkite/pipeline.yml +4 -4
  13. package/template/koa-rest-api/.gantry/common.yml +1 -1
  14. package/template/koa-rest-api/README.md +3 -7
  15. package/template/koa-rest-api/package.json +3 -3
  16. package/template/lambda-sqs-worker/.buildkite/pipeline.yml +2 -3
  17. package/template/lambda-sqs-worker/README.md +2 -6
  18. package/template/lambda-sqs-worker/serverless.yml +0 -3
  19. package/template/lambda-sqs-worker-cdk/.buildkite/pipeline.yml +2 -2
  20. package/template/oss-npm-package/README.md +5 -4
  21. package/template/private-npm-package/README.md +4 -7
package/README.md CHANGED
@@ -17,7 +17,7 @@
17
17
  - Deploy with [Gantry], [Serverless] or the [AWS CDK]
18
18
 
19
19
  [aws cdk]: https://docs.aws.amazon.com/cdk/latest/guide/work-with-cdk-typescript.html
20
- [gantry]: https://gantry.ssod.skinfra.xyz
20
+ [gantry]: https://backstage.myseek.xyz/docs/default/component/gantry/
21
21
  [serverless]: https://serverless.com/
22
22
 
23
23
  It provides you with:
package/lib/api/jest/index.d.ts CHANGED
@@ -95,25 +95,25 @@ export declare const mergePreset: <AdditionalOptions extends "filter" | "json" |
95
95
  slowTestThreshold: number;
96
96
  snapshotResolver: string;
97
97
  snapshotSerializers: string[];
98
- snapshotFormat: {
99
- readonly callToJSON?: boolean | undefined;
100
- readonly escapeRegex?: boolean | undefined;
101
- readonly escapeString?: boolean | undefined;
102
- readonly highlight?: boolean | undefined;
103
- readonly indent?: number | undefined;
104
- readonly maxDepth?: number | undefined;
105
- readonly maxWidth?: number | undefined;
106
- readonly min?: boolean | undefined;
107
- readonly printBasicPrototype?: boolean | undefined;
108
- readonly printFunctionName?: boolean | undefined;
109
- readonly theme?: {
110
- readonly value?: string | undefined;
111
- readonly tag?: string | undefined;
112
- readonly content?: string | undefined;
113
- readonly comment?: string | undefined;
114
- readonly prop?: string | undefined;
115
- } | undefined;
116
- };
98
+ snapshotFormat: Partial<{
99
+ readonly callToJSON: boolean;
100
+ readonly escapeRegex: boolean;
101
+ readonly escapeString: boolean;
102
+ readonly highlight: boolean;
103
+ readonly indent: number;
104
+ readonly maxDepth: number;
105
+ readonly maxWidth: number;
106
+ readonly min: boolean;
107
+ readonly printBasicPrototype: boolean;
108
+ readonly printFunctionName: boolean;
109
+ readonly theme: Partial<{
110
+ readonly value: string;
111
+ readonly tag: string;
112
+ readonly content: string;
113
+ readonly comment: string;
114
+ readonly prop: string;
115
+ }>;
116
+ }>;
117
117
  errorOnDeprecated: boolean;
118
118
  testEnvironment: string;
119
119
  testEnvironmentOptions: Record<string, unknown>;
package/lib/cli/test/reporters/github/annotations.js CHANGED
@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
6
6
  exports.generateAnnotationEntries = exports.createAnnotations = void 0;
7
7
  const path_1 = __importDefault(require("path"));
8
8
  const strip_ansi_1 = __importDefault(require("strip-ansi"));
9
+ const ts_dedent_1 = __importDefault(require("ts-dedent"));
9
10
  /**
10
11
  * Matches the first stack trace location in a Jest failure message.
11
12
  *
@@ -49,7 +50,9 @@ const createAnnotations = (testResults) => {
49
50
  path: path_1.default.relative(cwd, testResult.testFilePath),
50
51
  start_line: 1,
51
52
  end_line: 1,
52
- message: (0, strip_ansi_1.default)(testResult.testExecError.message),
53
+ message: (0, strip_ansi_1.default)(testResult.failureMessage
54
+ ? (0, ts_dedent_1.default)(testResult.failureMessage)
55
+ : testResult.testExecError.message),
53
56
  title: 'Jest',
54
57
  };
55
58
  }
package/lib/cli/test/reporters/github/annotations.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"annotations.js","sourceRoot":"","sources":["../../../../../src/cli/test/reporters/github/annotations.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AAGxB,4DAAmC;AAInC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,mBAAmB,GAAG,iCAAiC,CAAC;AAEvD,MAAM,iBAAiB,GAAG,CAC/B,WAAyB,EACJ,EAAE;IACvB,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAE1B,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;QACxC,IAAI,UAAU,CAAC,aAAa,EAAE;YAC5B,OAAO;gBACL,gBAAgB,EAAE,SAAS;gBAC3B,IAAI,EAAE,cAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,UAAU,CAAC,YAAY,CAAC;gBACjD,UAAU,EAAE,CAAC;gBACb,QAAQ,EAAE,CAAC;gBACX,OAAO,EAAE,IAAA,oBAAS,EAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC;gBACpD,KAAK,EAAE,MAAM;aACd,CAAC;SACH;QAED,IAAI,UAAU,CAAC,eAAe,GAAG,CAAC,EAAE;YAClC,OAAO,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE,CACxD,eAAe,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,EAAE;gBACzD,MAAM,KAAK,GAAG,mBAAmB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBACvD,IAAI,KAAK,EAAE,MAAM,KAAK,CAAC,EAAE;oBACvB,OAAO;wBACL,gBAAgB,EAAE,SAAS;wBAC3B,IAAI,EAAE,cAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;wBAClC,UAAU,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;wBAC5B,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;wBAC1B,YAAY,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;wBAC9B,UAAU,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;wBAC5B,OAAO,EAAE,IAAA,oBAAS,EAAC,cAAc,CAAC;wBAClC,KAAK,EAAE,MAAM;qBACd,CAAC;iBACH;gBAED,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC,CACH,CAAC;SACH;QAED,OAAO,EAAE,CAAC;IACZ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAzCW,QAAA,iBAAiB,qBAyC5B;AAEF,MAAM,oBAAoB,GAAG,MAAM,CAAC,sBAAsB,CAAC,CAAC;AAOrD,MAAM,yBAAyB,GAAG,CACvC,WAAyB,EACN,EAAE;IAGrB,sCAAsC;IACtC,MAAM,oBAAoB,GAAG,WAAW,CAAC,MAAM,CAC7C,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;QACd,MAAM,WAAW,GAAG,MAAM,CAAC,WAAW,EAAE,IAAI,IAAI,oBAAoB,CAAC;QAErE,CAAC,GAAG,CAAC,WAAW,MAAf,GAAG,CAAC,WAAW,IAAM,EAAE,EAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEvC,OAAO,GAAG,CAAC;IACb,CAAC,EACD,EAAE,CACH,CAAC;IAEF,MAAM,cAAc,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;IAElE,MAAM,OAAO,GAAG;QACd,GAAG,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAE,CAAC,CAAC,SAAS,EAAE,cAAc,CAAC,CAAW,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3E,GAAG,MAAM,CAAC,OAAO,CAAC,oBAAoB,CAAC;KACxC,CAAC;IAEF,4CAA4C;IAC5C,OAAO,OAAO,CAAC,GAAG,CAAkB,CAAC,CAAC,WAAW,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;QAC/D,WAAW,EAAE,IAAA,yBAAiB,EAAC,OAAO,CAAC;QACvC,WAAW;KACZ,CAAC,CAAC,CAAC;AACN,CAAC,CAAC;AA7BW,QAAA,yBAAyB,6BA6BpC"}
1
+ {"version":3,"file":"annotations.js","sourceRoot":"","sources":["../../../../../src/cli/test/reporters/github/annotations.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AAGxB,4DAAmC;AACnC,0DAA+B;AAI/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,mBAAmB,GAAG,iCAAiC,CAAC;AAEvD,MAAM,iBAAiB,GAAG,CAC/B,WAAyB,EACJ,EAAE;IACvB,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAE1B,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;QACxC,IAAI,UAAU,CAAC,aAAa,EAAE;YAC5B,OAAO;gBACL,gBAAgB,EAAE,SAAS;gBAC3B,IAAI,EAAE,cAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,UAAU,CAAC,YAAY,CAAC;gBACjD,UAAU,EAAE,CAAC;gBACb,QAAQ,EAAE,CAAC;gBACX,OAAO,EAAE,IAAA,oBAAS,EAChB,UAAU,CAAC,cAAc;oBACvB,CAAC,CAAC,IAAA,mBAAM,EAAC,UAAU,CAAC,cAAc,CAAC;oBACnC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CACrC;gBACD,KAAK,EAAE,MAAM;aACd,CAAC;SACH;QAED,IAAI,UAAU,CAAC,eAAe,GAAG,CAAC,EAAE;YAClC,OAAO,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE,CACxD,eAAe,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,EAAE;gBACzD,MAAM,KAAK,GAAG,mBAAmB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBACvD,IAAI,KAAK,EAAE,MAAM,KAAK,CAAC,EAAE;oBACvB,OAAO;wBACL,gBAAgB,EAAE,SAAS;wBAC3B,IAAI,EAAE,cAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;wBAClC,UAAU,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;wBAC5B,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;wBAC1B,YAAY,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;wBAC9B,UAAU,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;wBAC5B,OAAO,EAAE,IAAA,oBAAS,EAAC,cAAc,CAAC;wBAClC,KAAK,EAAE,MAAM;qBACd,CAAC;iBACH;gBAED,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC,CACH,CAAC;SACH;QAED,OAAO,EAAE,CAAC;IACZ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AA7CW,QAAA,iBAAiB,qBA6C5B;AAEF,MAAM,oBAAoB,GAAG,MAAM,CAAC,sBAAsB,CAAC,CAAC;AAOrD,MAAM,yBAAyB,GAAG,CACvC,WAAyB,EACN,EAAE;IAGrB,sCAAsC;IACtC,MAAM,oBAAoB,GAAG,WAAW,CAAC,MAAM,CAC7C,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;QACd,MAAM,WAAW,GAAG,MAAM,CAAC,WAAW,EAAE,IAAI,IAAI,oBAAoB,CAAC;QAErE,CAAC,GAAG,CAAC,WAAW,MAAf,GAAG,CAAC,WAAW,IAAM,EAAE,EAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEvC,OAAO,GAAG,CAAC;IACb,CAAC,EACD,EAAE,CACH,CAAC;IAEF,MAAM,cAAc,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;IAElE,MAAM,OAAO,GAAG;QACd,GAAG,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAE,CAAC,CAAC,SAAS,EAAE,cAAc,CAAC,CAAW,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3E,GAAG,MAAM,CAAC,OAAO,CAAC,oBAAoB,CAAC;KACxC,CAAC;IAEF,4CAA4C;IAC5C,OAAO,OAAO,CAAC,GAAG,CAAkB,CAAC,CAAC,WAAW,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;QAC/D,WAAW,EAAE,IAAA,yBAAiB,EAAC,OAAO,CAAC;QACvC,WAAW;KACZ,CAAC,CAAC,CAAC;AACN,CAAC,CAAC;AA7BW,QAAA,yBAAyB,6BA6BpC"}
package/lib/utils/args.d.ts CHANGED
@@ -15,7 +15,7 @@ export declare const hasSerialFlag: (args?: string[], env?: NodeJS.ProcessEnv) =
15
15
  * ```
16
16
  */
17
17
  export declare const parseProcessArgs: (args?: string[]) => {
18
- commandName: "format" | "node" | "test" | "release" | "build" | "build-package" | "configure" | "help" | "init" | "lint" | "start" | "version";
18
+ commandName: "format" | "node" | "test" | "release" | "version" | "build" | "build-package" | "configure" | "help" | "init" | "lint" | "start";
19
19
  args: string[];
20
20
  };
21
21
  interface RunArgs {
package/package.json CHANGED
@@ -6,9 +6,9 @@
6
6
  "url": "https://github.com/seek-oss/skuba/issues"
7
7
  },
8
8
  "dependencies": {
9
- "@octokit/graphql": "^4.8.0",
9
+ "@octokit/graphql": "^5.0.0",
10
10
  "@octokit/graphql-schema": "^10.73.0",
11
- "@octokit/rest": "^18.12.0",
11
+ "@octokit/rest": "^19.0.0",
12
12
  "@octokit/types": "^6.34.0",
13
13
  "@types/jest": "^28.0.0",
14
14
  "@types/node": ">=14.18",
@@ -28,7 +28,7 @@
28
28
  "is-installed-globally": "^0.4.0",
29
29
  "isomorphic-git": "^1.11.1",
30
30
  "jest": "^28.1.0",
31
- "jest-watch-typeahead": "^1.1.0",
31
+ "jest-watch-typeahead": "^2.0.0",
32
32
  "lodash.mergewith": "^4.6.2",
33
33
  "normalize-package-data": "^4.0.0",
34
34
  "npm-run-path": "^4.0.1",
@@ -42,6 +42,7 @@
42
42
  "serialize-error": "^8.0.1",
43
43
  "simple-git": "^3.5.0",
44
44
  "strip-ansi": "^6.0.1",
45
+ "ts-dedent": "^2.2.0",
45
46
  "ts-jest": "^28.0.2",
46
47
  "ts-node": "^10.7.0",
47
48
  "ts-node-dev": "^2.0.0",
@@ -51,26 +52,28 @@
51
52
  },
52
53
  "description": "SEEK development toolkit for backend applications and packages",
53
54
  "devDependencies": {
54
- "@changesets/cli": "2.23.0",
55
+ "@changesets/cli": "2.24.1",
55
56
  "@changesets/get-github-info": "0.5.1",
56
- "@jest/reporters": "28.1.1",
57
+ "@jest/reporters": "28.1.3",
57
58
  "@types/ejs": "3.1.1",
58
59
  "@types/express": "4.17.13",
59
60
  "@types/fs-extra": "9.0.13",
60
- "@types/koa": "2.13.4",
61
+ "@types/koa": "2.13.5",
61
62
  "@types/lodash.mergewith": "4.6.7",
62
63
  "@types/module-alias": "2.0.1",
63
64
  "@types/npm-which": "3.0.1",
64
65
  "@types/picomatch": "2.3.0",
65
66
  "@types/supertest": "2.0.12",
66
- "enhanced-resolve": "5.9.3",
67
+ "enhanced-resolve": "5.10.0",
67
68
  "express": "4.18.1",
68
69
  "jsonfile": "6.1.0",
69
70
  "koa": "2.13.4",
70
- "memfs": "3.4.6",
71
+ "memfs": "3.4.7",
72
+ "remark-cli": "11.0.0",
73
+ "remark-preset-lint-recommended": "6.1.2",
71
74
  "semver": "7.3.7",
72
- "supertest": "6.2.3",
73
- "type-fest": "2.13.1"
75
+ "supertest": "6.2.4",
76
+ "type-fest": "2.18.0"
74
77
  },
75
78
  "engines": {
76
79
  "node": ">=14.18"
@@ -97,6 +100,28 @@
97
100
  }
98
101
  },
99
102
  "private": false,
103
+ "remarkConfig": {
104
+ "plugins": [
105
+ "remark-preset-lint-recommended",
106
+ [
107
+ "remark-lint-list-item-indent",
108
+ false
109
+ ],
110
+ [
111
+ "remark-lint-no-shortcut-reference-link",
112
+ false
113
+ ],
114
+ [
115
+ "remark-lint-no-undefined-references",
116
+ {
117
+ "allow": [
118
+ " ",
119
+ "x"
120
+ ]
121
+ }
122
+ ]
123
+ ]
124
+ },
100
125
  "repository": {
101
126
  "type": "git",
102
127
  "url": "git+https://github.com/seek-oss/skuba.git"
@@ -108,7 +133,8 @@
108
133
  "build": "ts-node --transpile-only src/skuba build && scripts/postbuild.sh",
109
134
  "deploy": "scripts/deploy.sh",
110
135
  "format": "yarn skuba format",
111
- "lint": "yarn skuba lint",
136
+ "lint": "yarn skuba lint && yarn lint:md",
137
+ "lint:md": "remark --frail --quiet .",
112
138
  "release": "yarn build && changeset publish",
113
139
  "stage": "changeset version && yarn format",
114
140
  "skuba": "yarn build && node lib/skuba",
@@ -126,5 +152,5 @@
126
152
  "version": "4.0.0"
127
153
  },
128
154
  "types": "./lib/index.d.ts",
129
- "version": "4.3.0"
155
+ "version": "4.3.1"
130
156
  }
package/template/express-rest-api/.buildkite/pipeline.yml CHANGED
@@ -51,7 +51,7 @@ steps:
51
51
  - *aws-sm
52
52
  - *private-npm
53
53
  - *docker-ecr-cache
54
- - docker-compose#v3.9.0:
54
+ - docker-compose#v3.10.0:
55
55
  run: app
56
56
  timeout_in_minutes: 10
57
57
 
@@ -61,7 +61,7 @@ steps:
61
61
  - *aws-sm
62
62
  - *private-npm
63
63
  - *docker-ecr-cache
64
- - seek-jobs/gantry#v1.8.1:
64
+ - seek-jobs/gantry#v2.0.0:
65
65
  command: build
66
66
  file: gantry.build.yml
67
67
  region: <%- region %>
@@ -78,7 +78,7 @@ steps:
78
78
  concurrency_group: <%- teamName %>/deploy/gantry/<%- devGantryEnvironmentName %>
79
79
  key: deploy-dev
80
80
  plugins:
81
- - seek-jobs/gantry#v1.8.1:
81
+ - seek-jobs/gantry#v2.0.0:
82
82
  command: apply
83
83
  environment: <%- devGantryEnvironmentName %>
84
84
  file: gantry.apply.yml
@@ -93,7 +93,7 @@ steps:
93
93
  concurrency_group: <%- teamName %>/deploy/gantry/<%- prodGantryEnvironmentName %>
94
94
  depends_on: deploy-dev
95
95
  plugins:
96
- - seek-jobs/gantry#v1.8.1:
96
+ - seek-jobs/gantry#v2.0.0:
97
97
  command: apply
98
98
  environment: <%- prodGantryEnvironmentName %>
99
99
  file: gantry.apply.yml
package/template/express-rest-api/.gantry/common.yml CHANGED
@@ -4,7 +4,7 @@ image: '{{values "prodAccountId"}}.dkr.ecr.<%- region %>.amazonaws.com/{{values
4
4
  service: '<%- serviceName %>'
5
5
 
6
6
  # TODO: enable Datadog agent
7
- # https://gantry.ssod.skinfra.xyz/docs/v1/resources/service.html#datadogSecretId
7
+ # https://backstage.myseek.xyz/docs/default/component/gantry/v1/reference/resources/service/#datadogSecretId
8
8
  # datadogSecretId: arn:aws:secretsmanager:<%- region %>:<aws-account-id>:secret:<secret-name>
9
9
 
10
10
  tags:
package/template/express-rest-api/README.md CHANGED
@@ -19,15 +19,11 @@ Next steps:
19
19
  see the [Gantry] documentation for more information.
20
20
  6. [ ] Push local commits to the upstream GitHub branch.
21
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 😌.
22
+ 8. [ ] Delete this checklist 😌.
25
23
 
26
- [arm64]: https://seek-oss.github.io/skuba/docs/deep-dives/arm64.html
24
+ [arm64 guide]: https://seek-oss.github.io/skuba/docs/deep-dives/arm64.html
27
25
  [builds at seek]: https://builds-at-seek.ssod.skinfra.xyz
28
26
  [github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
29
- [renovate]: https://github.com/apps/renovate
30
- [seek-jobs/renovate]: https://github.com/SEEK-Jobs/renovate
31
27
 
32
28
  ## Design
33
29
 
@@ -109,5 +105,5 @@ TODO: add support links for the prod environment.
109
105
 
110
106
  [codedeploy]: https://docs.aws.amazon.com/codedeploy
111
107
  [express]: https://expressjs.com
112
- [gantry]: https://gantry.ssod.skinfra.xyz
108
+ [gantry]: https://backstage.myseek.xyz/docs/default/component/gantry/
113
109
  [technology strategy]: https://tech-strategy.ssod.skinfra.xyz
package/template/greeter/.buildkite/pipeline.yml CHANGED
@@ -32,6 +32,6 @@ steps:
32
32
  - *aws-sm
33
33
  - *private-npm
34
34
  - *docker-ecr-cache
35
- - docker-compose#v3.9.0:
35
+ - docker-compose#v3.10.0:
36
36
  run: app
37
37
  timeout_in_minutes: 10
package/template/greeter/README.md CHANGED
@@ -17,15 +17,11 @@ Next steps:
17
17
  see [Builds at SEEK] for more information.
18
18
  5. [ ] Push local commits to the upstream GitHub branch.
19
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 😌.
20
+ 7. [ ] Delete this checklist 😌.
23
21
 
24
- [arm64]: https://seek-oss.github.io/skuba/docs/deep-dives/arm64.html
22
+ [arm64 guide]: https://seek-oss.github.io/skuba/docs/deep-dives/arm64.html
25
23
  [builds at seek]: https://builds-at-seek.ssod.skinfra.xyz
26
24
  [github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
27
- [renovate]: https://github.com/apps/renovate
28
- [seek-jobs/renovate]: https://github.com/SEEK-Jobs/renovate
29
25
 
30
26
  ## Design
31
27
 
@@ -35,8 +31,8 @@ or serve as a starting point for a backend project if the other built-in templat
35
31
 
36
32
  It's a barebones Node.js application that comprises:
37
33
 
38
- - A [src/app.ts] that can be run locally to greet the user
39
- - A [src/app.test.ts] that demonstrates rudimentary Jest usage
34
+ - A [src/app.ts](src/app.ts) that can be run locally to greet the user
35
+ - A [src/app.test.ts](src/app.test.ts) that demonstrates rudimentary Jest usage
40
36
 
41
37
  ## Development
42
38
 
package/template/koa-rest-api/.buildkite/pipeline.yml CHANGED
@@ -51,7 +51,7 @@ steps:
51
51
  - *aws-sm
52
52
  - *private-npm
53
53
  - *docker-ecr-cache
54
- - docker-compose#v3.9.0:
54
+ - docker-compose#v3.10.0:
55
55
  run: app
56
56
  timeout_in_minutes: 10
57
57
 
@@ -61,7 +61,7 @@ steps:
61
61
  - *aws-sm
62
62
  - *private-npm
63
63
  - *docker-ecr-cache
64
- - seek-jobs/gantry#v1.8.1:
64
+ - seek-jobs/gantry#v2.0.0:
65
65
  command: build
66
66
  file: gantry.build.yml
67
67
  region: <%- region %>
@@ -78,7 +78,7 @@ steps:
78
78
  concurrency_group: <%- teamName %>/deploy/gantry/<%- devGantryEnvironmentName %>
79
79
  key: deploy-dev
80
80
  plugins:
81
- - seek-jobs/gantry#v1.8.1:
81
+ - seek-jobs/gantry#v2.0.0:
82
82
  command: apply
83
83
  environment: <%- devGantryEnvironmentName %>
84
84
  file: gantry.apply.yml
@@ -93,7 +93,7 @@ steps:
93
93
  concurrency_group: <%- teamName %>/deploy/gantry/<%- prodGantryEnvironmentName %>
94
94
  depends_on: deploy-dev
95
95
  plugins:
96
- - seek-jobs/gantry#v1.8.1:
96
+ - seek-jobs/gantry#v2.0.0:
97
97
  command: apply
98
98
  environment: <%- prodGantryEnvironmentName %>
99
99
  file: gantry.apply.yml
package/template/koa-rest-api/.gantry/common.yml CHANGED
@@ -4,7 +4,7 @@ image: '{{values "prodAccountId"}}.dkr.ecr.<%- region %>.amazonaws.com/{{values
4
4
  service: '<%- serviceName %>'
5
5
 
6
6
  # TODO: enable Datadog agent
7
- # https://gantry.ssod.skinfra.xyz/docs/v1/resources/service.html#datadogSecretId
7
+ # https://backstage.myseek.xyz/docs/default/component/gantry/v1/reference/resources/service/#datadogSecretId
8
8
  # datadogSecretId: arn:aws:secretsmanager:<%- region %>:<aws-account-id>:secret:<secret-name>
9
9
 
10
10
  tags:
package/template/koa-rest-api/README.md CHANGED
@@ -19,15 +19,11 @@ Next steps:
19
19
  see the [Gantry] documentation for more information.
20
20
  6. [ ] Push local commits to the upstream GitHub branch.
21
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 😌.
22
+ 8. [ ] Delete this checklist 😌.
25
23
 
26
- [arm64]: https://seek-oss.github.io/skuba/docs/deep-dives/arm64.html
24
+ [arm64 guide]: https://seek-oss.github.io/skuba/docs/deep-dives/arm64.html
27
25
  [builds at seek]: https://builds-at-seek.ssod.skinfra.xyz
28
26
  [github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
29
- [renovate]: https://github.com/apps/renovate
30
- [seek-jobs/renovate]: https://github.com/SEEK-Jobs/renovate
31
27
 
32
28
  ## Design
33
29
 
@@ -113,6 +109,6 @@ TODO: add support links for the prod environment.
113
109
  -->
114
110
 
115
111
  [codedeploy]: https://docs.aws.amazon.com/codedeploy
116
- [gantry]: https://gantry.ssod.skinfra.xyz
112
+ [gantry]: https://backstage.myseek.xyz/docs/default/component/gantry/
117
113
  [koa]: https://koajs.com
118
114
  [technology strategy]: https://tech-strategy.ssod.skinfra.xyz
package/template/koa-rest-api/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "dependencies": {
3
- "@koa/router": "^10.1.1",
3
+ "@koa/router": "^12.0.0",
4
4
  "@opentelemetry/api": "^1.1.0",
5
5
  "@opentelemetry/exporter-collector-grpc": "^0.25.0",
6
6
  "@opentelemetry/instrumentation-aws-sdk": "^0.8.0",
7
- "@opentelemetry/instrumentation-http": "^0.29.2",
8
- "@opentelemetry/sdk-node": "^0.29.2",
7
+ "@opentelemetry/instrumentation-http": "^0.31.0",
8
+ "@opentelemetry/sdk-node": "^0.31.0",
9
9
  "@seek/logger": "^5.0.1",
10
10
  "aws-sdk": "^2.1039.0",
11
11
  "hot-shots": "^9.0.0",
package/template/lambda-sqs-worker/.buildkite/pipeline.yml CHANGED
@@ -32,10 +32,9 @@ configs:
32
32
  - *aws-sm
33
33
  - *private-npm
34
34
  - *docker-ecr-cache
35
- - docker-compose#v3.9.0:
35
+ - docker-compose#v3.10.0:
36
36
  dependencies: false
37
37
  run: app
38
- tty: false
39
38
  retry:
40
39
  manual:
41
40
  # Only use this if you need to roll back a deployment ASAP.
@@ -61,7 +60,7 @@ steps:
61
60
  - *aws-sm
62
61
  - *private-npm
63
62
  - *docker-ecr-cache
64
- - docker-compose#v3.9.0:
63
+ - docker-compose#v3.10.0:
65
64
  run: app
66
65
  timeout_in_minutes: 10
67
66
 
package/template/lambda-sqs-worker/README.md CHANGED
@@ -18,15 +18,11 @@ Next steps:
18
18
  5. [ ] Add deployment bucket configuration and data classification tags to [serverless.yml](serverless.yml).
19
19
  6. [ ] Push local commits to the upstream GitHub branch.
20
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 😌.
21
+ 8. [ ] Delete this checklist 😌.
24
22
 
25
- [arm64]: https://seek-oss.github.io/skuba/docs/deep-dives/arm64.html
23
+ [arm64 guide]: https://seek-oss.github.io/skuba/docs/deep-dives/arm64.html
26
24
  [builds at seek]: https://builds-at-seek.ssod.skinfra.xyz
27
25
  [github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
28
- [renovate]: https://github.com/apps/renovate
29
- [seek-jobs/renovate]: https://github.com/SEEK-Jobs/renovate
30
26
 
31
27
  ## Design
32
28
 
package/template/lambda-sqs-worker/serverless.yml CHANGED
@@ -54,9 +54,6 @@ provider:
54
54
  - Action: sns:Publish
55
55
  Effect: Allow
56
56
  Resource: !Ref DestinationTopic
57
- - Action: sqs:SendMessage*
58
- Effect: Allow
59
- Resource: !GetAtt DeadLetterQueue.Arn
60
57
  stackTags:
61
58
  # TODO: add data classification tags
62
59
  # https://rfc.skinfra.xyz/RFC019-AWS-Tagging-Standard.html#seekdataconsumers
package/template/lambda-sqs-worker-cdk/.buildkite/pipeline.yml CHANGED
@@ -32,7 +32,7 @@ configs:
32
32
  - *aws-sm
33
33
  - *private-npm
34
34
  - *docker-ecr-cache
35
- - docker-compose#v3.9.0:
35
+ - docker-compose#v3.10.0:
36
36
  dependencies: false
37
37
  run: app
38
38
  retry:
@@ -57,7 +57,7 @@ steps:
57
57
  - *aws-sm
58
58
  - *private-npm
59
59
  - *docker-ecr-cache
60
- - docker-compose#v3.9.0:
60
+ - docker-compose#v3.10.0:
61
61
  run: app
62
62
  timeout_in_minutes: 10
63
63
 
package/template/oss-npm-package/README.md CHANGED
@@ -16,6 +16,11 @@ Next steps:
16
16
  request installation in [#open-source].
17
17
  6. [ ] Delete this checklist 😌.
18
18
 
19
+ [#open-source]: https://slack.com/app_redirect?channel=C39P1H2SU
20
+ [github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
21
+ [renovate]: https://github.com/apps/renovate
22
+ [seek's open source rfc]: https://rfc.skinfra.xyz/RFC016-Open-Source.html
23
+
19
24
  ## API
20
25
 
21
26
  ### `log`
@@ -115,13 +120,9 @@ Here are some branches that **semantic-release** supports by default:
115
120
 
116
121
  For more information, see the **semantic-release** docs on [triggering a release].
117
122
 
118
- [#open-source]: https://slack.com/app_redirect?channel=C39P1H2SU
119
123
  [distribution tags]: https://docs.npmjs.com/adding-dist-tags-to-packages
120
124
  [oss npm package guidance]: https://github.com/SEEK-Jobs/seek-oss-ci/blob/master/NPM_PACKAGES.md#access-to-publish-to-npm
121
125
  [release workflow]: .github/workflows/release.yml
122
126
  [seek-oss]: https://github.com/seek-oss
123
- [github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
124
- [seek's open source rfc]: https://rfc.skinfra.xyz/RFC016-Open-Source.html
125
- [renovate]: https://github.com/apps/renovate
126
127
  [semantic-release]: https://github.com/semantic-release/semantic-release
127
128
  [triggering a release]: https://github.com/semantic-release/semantic-release/#triggering-a-release
package/template/private-npm-package/README.md CHANGED
@@ -12,9 +12,10 @@ Next steps:
12
12
  2. [ ] Follow [Gutenberg] instructions for [installing on your repository].
13
13
  3. [ ] Push local commits to the upstream GitHub branch.
14
14
  4. [ ] Configure [GitHub repository settings].
15
- 5. [ ] Keep dependencies up to date with [Renovate];
16
- request installation in [SEEK-Jobs/renovate].
17
- 6. [ ] Delete this checklist 😌.
15
+ 5. [ ] Delete this checklist 😌.
16
+
17
+ [github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
18
+ [installing on your repository]: https://github.com/SEEK-Jobs/gutenberg#installing-on-your-repository
18
19
 
19
20
  ## API
20
21
 
@@ -102,11 +103,7 @@ Here are some branches that **semantic-release** supports by default:
102
103
  For more information, see the **semantic-release** docs on [triggering a release].
103
104
 
104
105
  [distribution tags]: https://docs.npmjs.com/adding-dist-tags-to-packages
105
- [github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
106
106
  [gutenberg]: https://github.com/SEEK-Jobs/gutenberg
107
- [installing on your repository]: https://github.com/SEEK-Jobs/gutenberg#installing-on-your-repository
108
- [renovate]: https://github.com/apps/renovate
109
107
  [seek-jobs]: https://github.com/orgs/seek-jobs/sso
110
- [seek-jobs/renovate]: https://github.com/SEEK-Jobs/renovate
111
108
  [semantic-release]: https://github.com/semantic-release/semantic-release
112
109
  [triggering a release]: https://github.com/semantic-release/semantic-release/#triggering-a-release