@linzjs/cdk-tags 1.1.0 → 1.2.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.
package/README.md CHANGED
@@ -17,6 +17,7 @@ applyTags(bucket, {
17
17
  group: 'li',
18
18
  classification: SecurityClassification.Unclassified,
19
19
  data: { isMaster: true, isPublic: true, role: TagDataRole.Archive },
20
+ criticality: 'low',
20
21
  });
21
22
  ```
22
23
 
@@ -42,6 +42,20 @@ export interface TagsBase {
42
42
  * @see https://www.digital.govt.nz/standards-and-guidance/governance/managing-online-channels/security-and-privacy-for-websites/foundations/classify-information/
43
43
  */
44
44
  classification: SecurityClassification;
45
+ /**
46
+ * Criticality of the resources
47
+ */
48
+ criticality: 'critical' | 'high' | 'medium' | 'low';
49
+ /**
50
+ * THe responder team listed in OpsGenie.
51
+ * @see https://toitutewhenua.app.opsgenie.com/teams/list
52
+ */
53
+ responderTeam?: string;
54
+ /**
55
+ * skip collection of git info, commit, version etc
56
+ * @default false
57
+ */
58
+ skipGitInfo?: boolean;
45
59
  /** Data classification tags */
46
60
  data?: TagsData;
47
61
  }
package/build/src/tags.js CHANGED
@@ -17,28 +17,33 @@ function applyTags(construct, ctx) {
17
17
  if (ctx.data?.isPublic && ctx.classification !== security_js_1.SecurityClassification.Unclassified) {
18
18
  throw new Error('Only unclassified constructs can be made public');
19
19
  }
20
- const buildInfo = (0, build_js_1.getGitBuildInfo)();
20
+ const buildInfo = ctx.skipGitInfo ? undefined : (0, build_js_1.getGitBuildInfo)();
21
21
  // applications tags
22
- tag(construct, 'linz:app:name', ctx.application);
23
- tag(construct, 'linz:app:version', buildInfo.version);
24
- tag(construct, 'linz:environment', ctx.environment);
22
+ tag(construct, 'linz.app.name', ctx.application);
23
+ if (buildInfo)
24
+ tag(construct, 'linz.app.version', buildInfo.version);
25
+ tag(construct, 'linz.environment', ctx.environment);
25
26
  // Ownership tags
26
- tag(construct, 'linz:group', ctx.group);
27
+ tag(construct, 'linz.group', ctx.group);
28
+ tag(construct, 'linz.responder.team', ctx.responderTeam ?? 'NotSet');
29
+ tag(construct, 'linz.app.criticality', ctx.criticality);
27
30
  // Git Tags
28
- tag(construct, 'linz:git:hash', buildInfo.hash);
29
- tag(construct, 'linz:git:repository', process.env['GITHUB_REPOSITORY'] ?? ctx.repository);
31
+ if (buildInfo)
32
+ tag(construct, 'linz.git.hash', buildInfo.hash);
33
+ tag(construct, 'linz.git.repository', process.env['GITHUB_REPOSITORY'] ?? ctx.repository);
30
34
  // Github actions build information
31
- tag(construct, 'linz:build:id', buildInfo.buildId);
35
+ if (buildInfo)
36
+ tag(construct, 'linz.build.id', buildInfo.buildId);
32
37
  // Security
33
- tag(construct, 'linz:security:classification', ctx.classification);
38
+ tag(construct, 'linz.security.classification', ctx.classification);
34
39
  if (ctx.data)
35
40
  applyTagsData(construct, ctx.data);
36
41
  }
37
42
  exports.applyTags = applyTags;
38
43
  function applyTagsData(construct, tags) {
39
- tag(construct, 'linz:data:role', tags.role);
40
- tag(construct, 'linz:data:is-master', String(tags.isMaster ?? false));
41
- tag(construct, 'linz:data:is-public', String(tags.isPublic ?? false));
44
+ tag(construct, 'linz.data.role', tags.role);
45
+ tag(construct, 'linz.data.is-master', String(tags.isMaster ?? false));
46
+ tag(construct, 'linz.data.is-public', String(tags.isPublic ?? false));
42
47
  }
43
48
  exports.applyTagsData = applyTagsData;
44
49
  //# sourceMappingURL=tags.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"tags.js","sourceRoot":"","sources":["../../src/tags.ts"],"names":[],"mappings":";;;AAAA,6CAAmC;AAGnC,yCAA6C;AAE7C,+CAAuD;AAoDvD,6EAA6E;AAC7E,SAAS,GAAG,CAAC,SAAqB,EAAE,GAAW,EAAE,KAAgC;IAC/E,IAAI,KAAK,IAAI,IAAI;QAAE,OAAO;IAC1B,IAAI,KAAK,KAAK,EAAE;QAAE,OAAO;IAEzB,kBAAI,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACrC,CAAC;AAED,SAAgB,SAAS,CAAC,SAAqB,EAAE,GAAa;IAC5D,iCAAiC;IACjC,IAAI,GAAG,CAAC,IAAI,EAAE,QAAQ,IAAI,GAAG,CAAC,cAAc,KAAK,oCAAsB,CAAC,YAAY,EAAE,CAAC;QACrF,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACrE,CAAC;IACD,MAAM,SAAS,GAAG,IAAA,0BAAe,GAAE,CAAC;IAEpC,oBAAoB;IACpB,GAAG,CAAC,SAAS,EAAE,eAAe,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC;IACjD,GAAG,CAAC,SAAS,EAAE,kBAAkB,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IACtD,GAAG,CAAC,SAAS,EAAE,kBAAkB,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC;IAEpD,iBAAiB;IACjB,GAAG,CAAC,SAAS,EAAE,YAAY,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;IAExC,WAAW;IACX,GAAG,CAAC,SAAS,EAAE,eAAe,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;IAChD,GAAG,CAAC,SAAS,EAAE,qBAAqB,EAAE,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC;IAE1F,mCAAmC;IACnC,GAAG,CAAC,SAAS,EAAE,eAAe,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IAEnD,WAAW;IACX,GAAG,CAAC,SAAS,EAAE,8BAA8B,EAAE,GAAG,CAAC,cAAc,CAAC,CAAC;IACnE,IAAI,GAAG,CAAC,IAAI;QAAE,aAAa,CAAC,SAAS,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;AACnD,CAAC;AAzBD,8BAyBC;AAED,SAAgB,aAAa,CAAC,SAAqB,EAAE,IAAc;IACjE,GAAG,CAAC,SAAS,EAAE,gBAAgB,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,GAAG,CAAC,SAAS,EAAE,qBAAqB,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,IAAI,KAAK,CAAC,CAAC,CAAC;IACtE,GAAG,CAAC,SAAS,EAAE,qBAAqB,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,IAAI,KAAK,CAAC,CAAC,CAAC;AACxE,CAAC;AAJD,sCAIC"}
1
+ {"version":3,"file":"tags.js","sourceRoot":"","sources":["../../src/tags.ts"],"names":[],"mappings":";;;AAAA,6CAAmC;AAGnC,yCAA6C;AAE7C,+CAAuD;AAoEvD,6EAA6E;AAC7E,SAAS,GAAG,CAAC,SAAqB,EAAE,GAAW,EAAE,KAAgC;IAC/E,IAAI,KAAK,IAAI,IAAI;QAAE,OAAO;IAC1B,IAAI,KAAK,KAAK,EAAE;QAAE,OAAO;IAEzB,kBAAI,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACrC,CAAC;AAED,SAAgB,SAAS,CAAC,SAAqB,EAAE,GAAa;IAC5D,iCAAiC;IACjC,IAAI,GAAG,CAAC,IAAI,EAAE,QAAQ,IAAI,GAAG,CAAC,cAAc,KAAK,oCAAsB,CAAC,YAAY,EAAE,CAAC;QACrF,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,SAAS,GAAG,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAA,0BAAe,GAAE,CAAC;IAElE,oBAAoB;IACpB,GAAG,CAAC,SAAS,EAAE,eAAe,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC;IACjD,IAAI,SAAS;QAAE,GAAG,CAAC,SAAS,EAAE,kBAAkB,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IACrE,GAAG,CAAC,SAAS,EAAE,kBAAkB,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC;IAEpD,iBAAiB;IACjB,GAAG,CAAC,SAAS,EAAE,YAAY,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;IACxC,GAAG,CAAC,SAAS,EAAE,qBAAqB,EAAE,GAAG,CAAC,aAAa,IAAI,QAAQ,CAAC,CAAC;IACrE,GAAG,CAAC,SAAS,EAAE,sBAAsB,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC;IAExD,WAAW;IACX,IAAI,SAAS;QAAE,GAAG,CAAC,SAAS,EAAE,eAAe,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;IAC/D,GAAG,CAAC,SAAS,EAAE,qBAAqB,EAAE,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC;IAE1F,mCAAmC;IACnC,IAAI,SAAS;QAAE,GAAG,CAAC,SAAS,EAAE,eAAe,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IAElE,WAAW;IACX,GAAG,CAAC,SAAS,EAAE,8BAA8B,EAAE,GAAG,CAAC,cAAc,CAAC,CAAC;IACnE,IAAI,GAAG,CAAC,IAAI;QAAE,aAAa,CAAC,SAAS,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;AACnD,CAAC;AA5BD,8BA4BC;AAED,SAAgB,aAAa,CAAC,SAAqB,EAAE,IAAc;IACjE,GAAG,CAAC,SAAS,EAAE,gBAAgB,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,GAAG,CAAC,SAAS,EAAE,qBAAqB,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,IAAI,KAAK,CAAC,CAAC,CAAC;IACtE,GAAG,CAAC,SAAS,EAAE,qBAAqB,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,IAAI,KAAK,CAAC,CAAC,CAAC;AACxE,CAAC;AAJD,sCAIC"}
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@linzjs/cdk-tags",
3
- "version": "1.1.0",
3
+ "version": "1.2.1",
4
4
  "main": "build/src/index.js",
5
5
  "types": "build/src/index.d.ts",
6
6
  "files": [
7
- "build"
7
+ "build/src"
8
8
  ],
9
9
  "author": {
10
10
  "name": "Land Information New Zealand",
@@ -23,7 +23,7 @@
23
23
  "access": "public"
24
24
  },
25
25
  "repository": {
26
- "url": "git://github.com/linz/cdk-tag.git",
26
+ "url": "git://github.com/linz/cdk-tags.git",
27
27
  "type": "git"
28
28
  },
29
29
  "peerDependencies": {
@@ -32,6 +32,6 @@
32
32
  },
33
33
  "devDependencies": {
34
34
  "@linzjs/style": "^5.2.0",
35
- "@types/node": "^20.11.30"
35
+ "@types/node": "^20.12.8"
36
36
  }
37
37
  }