@skeptools/skep-organization-project 0.0.11 → 0.0.12

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/.jsii CHANGED
@@ -74,7 +74,7 @@
74
74
  "stability": "stable"
75
75
  },
76
76
  "homepage": "git@github.com:skeptools/skep-organization-project.git",
77
- "jsiiVersion": "1.74.0 (build 6d08790)",
77
+ "jsiiVersion": "1.76.0 (build a2651be)",
78
78
  "license": "Apache-2.0",
79
79
  "metadata": {
80
80
  "jsii": {
@@ -167,6 +167,6 @@
167
167
  "symbolId": "src/skep-organization-project:SkepOrganizationProjectOptions"
168
168
  }
169
169
  },
170
- "version": "0.0.11",
171
- "fingerprint": "PAKwjJ2nNfFJuOX8Nk89Jn4dwAmmScQSGslElOmYcCI="
170
+ "version": "0.0.12",
171
+ "fingerprint": "6vLpdQ0UmzLsvLA2oMLL95/JTAbSZSqYCRLxFvui48k="
172
172
  }
package/API.md CHANGED
@@ -19,6 +19,7 @@ const skepOrganizationProjectOptions: SkepOrganizationProjectOptions = { ... }
19
19
  | --- | --- | --- |
20
20
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.name">name</a></code> | <code>string</code> | This is the name of your project. |
21
21
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
22
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.gitOptions">gitOptions</a></code> | <code>projen.GitOptions</code> | Configuration options for git. |
22
23
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.logging">logging</a></code> | <code>projen.LoggerOptions</code> | Configure logging options such as verbosity. |
23
24
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.outdir">outdir</a></code> | <code>string</code> | The root directory of the project. |
24
25
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.parent">parent</a></code> | <code>projen.Project</code> | The parent project, if this project is part of a bigger project. |
@@ -151,6 +152,8 @@ const skepOrganizationProjectOptions: SkepOrganizationProjectOptions = { ... }
151
152
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
152
153
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.artifactsFolder">artifactsFolder</a></code> | <code>string</code> | Configurable folder for artifacts to package when transitioning from plan to apply. |
153
154
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.deploymentEnvironments">deploymentEnvironments</a></code> | <code>{[ key: string ]: @rlmartin-projen/cdktf-project.DeploymentEnvironment}</code> | Add GitHub Wokflows for enabled environments. |
155
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.embeddedNamespace">embeddedNamespace</a></code> | <code>string</code> | Used to scope the embedded packages to avoid naming collisions. |
156
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.embeddedPackages">embeddedPackages</a></code> | <code>{[ key: string ]: @rlmartin-projen/cdktf-project.EmbeddedPackage}</code> | Small functions to be deployed with the other resources in the repo. |
154
157
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.nodeScripts">nodeScripts</a></code> | <code>{[ key: string ]: string}</code> | A set of scripts to be added to package.json but not wrapped by projen. |
155
158
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.npmrc">npmrc</a></code> | <code>string[]</code> | Raw lines to drop into the workflow's .npmrc file, to access private package. Empty implies no .npmrc required. |
156
159
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.repoAdmins">repoAdmins</a></code> | <code>{[ key: string ]: number}</code> | The GitHub Team slug (including the org_name/ prefix) or GitHub username for the teams/people who maintain infrastructure. |
@@ -189,6 +192,18 @@ Whether to commit the managed files by default.
189
192
 
190
193
  ---
191
194
 
195
+ ##### `gitOptions`<sup>Optional</sup> <a name="gitOptions" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.gitOptions"></a>
196
+
197
+ ```typescript
198
+ public readonly gitOptions: GitOptions;
199
+ ```
200
+
201
+ - *Type:* projen.GitOptions
202
+
203
+ Configuration options for git.
204
+
205
+ ---
206
+
192
207
  ##### `logging`<sup>Optional</sup> <a name="logging" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.logging"></a>
193
208
 
194
209
  ```typescript
@@ -2066,6 +2081,35 @@ Add GitHub Wokflows for enabled environments.
2066
2081
 
2067
2082
  ---
2068
2083
 
2084
+ ##### `embeddedNamespace`<sup>Optional</sup> <a name="embeddedNamespace" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.embeddedNamespace"></a>
2085
+
2086
+ ```typescript
2087
+ public readonly embeddedNamespace: string;
2088
+ ```
2089
+
2090
+ - *Type:* string
2091
+ - *Default:* top-level project name
2092
+
2093
+ Used to scope the embedded packages to avoid naming collisions.
2094
+
2095
+ ---
2096
+
2097
+ ##### `embeddedPackages`<sup>Optional</sup> <a name="embeddedPackages" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.embeddedPackages"></a>
2098
+
2099
+ ```typescript
2100
+ public readonly embeddedPackages: {[ key: string ]: EmbeddedPackage};
2101
+ ```
2102
+
2103
+ - *Type:* {[ key: string ]: @rlmartin-projen/cdktf-project.EmbeddedPackage}
2104
+ - *Default:* {}
2105
+
2106
+ Small functions to be deployed with the other resources in the repo.
2107
+
2108
+ Should be viewed more as infrastructure than services. Testing and linting
2109
+ intentionally mirror the overall repo.
2110
+
2111
+ ---
2112
+
2069
2113
  ##### `nodeScripts`<sup>Optional</sup> <a name="nodeScripts" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.nodeScripts"></a>
2070
2114
 
2071
2115
  ```typescript
@@ -2244,6 +2288,7 @@ new SkepOrganizationProject(options: SkepOrganizationProjectOptions)
2244
2288
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.removeScript">removeScript</a></code> | Removes the npm script (always successful). |
2245
2289
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.renderWorkflowSetup">renderWorkflowSetup</a></code> | Returns the set of workflow steps which should be executed to bootstrap a workflow. |
2246
2290
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.setScript">setScript</a></code> | Replaces the contents of an npm package.json script. |
2291
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.addEmbeddedPackage">addEmbeddedPackage</a></code> | *No description.* |
2247
2292
 
2248
2293
  ---
2249
2294
 
@@ -2741,6 +2786,36 @@ The command to execute.
2741
2786
 
2742
2787
  ---
2743
2788
 
2789
+ ##### `addEmbeddedPackage` <a name="addEmbeddedPackage" id="@skeptools/skep-organization-project.SkepOrganizationProject.addEmbeddedPackage"></a>
2790
+
2791
+ ```typescript
2792
+ public addEmbeddedPackage(name: string, config: EmbeddedPackage, majorVersion: number, namespaceOpt?: string): void
2793
+ ```
2794
+
2795
+ ###### `name`<sup>Required</sup> <a name="name" id="@skeptools/skep-organization-project.SkepOrganizationProject.addEmbeddedPackage.parameter.name"></a>
2796
+
2797
+ - *Type:* string
2798
+
2799
+ ---
2800
+
2801
+ ###### `config`<sup>Required</sup> <a name="config" id="@skeptools/skep-organization-project.SkepOrganizationProject.addEmbeddedPackage.parameter.config"></a>
2802
+
2803
+ - *Type:* @rlmartin-projen/cdktf-project.EmbeddedPackage
2804
+
2805
+ ---
2806
+
2807
+ ###### `majorVersion`<sup>Required</sup> <a name="majorVersion" id="@skeptools/skep-organization-project.SkepOrganizationProject.addEmbeddedPackage.parameter.majorVersion"></a>
2808
+
2809
+ - *Type:* number
2810
+
2811
+ ---
2812
+
2813
+ ###### `namespaceOpt`<sup>Optional</sup> <a name="namespaceOpt" id="@skeptools/skep-organization-project.SkepOrganizationProject.addEmbeddedPackage.parameter.namespaceOpt"></a>
2814
+
2815
+ - *Type:* string
2816
+
2817
+ ---
2818
+
2744
2819
 
2745
2820
  #### Properties <a name="Properties" id="Properties"></a>
2746
2821
 
@@ -25,5 +25,5 @@ class SkepOrganizationProject extends cdktf_project_1.CdktfProject {
25
25
  }
26
26
  exports.SkepOrganizationProject = SkepOrganizationProject;
27
27
  _a = JSII_RTTI_SYMBOL_1;
28
- SkepOrganizationProject[_a] = { fqn: "@skeptools/skep-organization-project.SkepOrganizationProject", version: "0.0.11" };
28
+ SkepOrganizationProject[_a] = { fqn: "@skeptools/skep-organization-project.SkepOrganizationProject", version: "0.0.12" };
29
29
  //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2tlcC1vcmdhbml6YXRpb24tcHJvamVjdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9za2VwLW9yZ2FuaXphdGlvbi1wcm9qZWN0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBQUEsNkJBQTZCO0FBQzdCLGtFQUFtRjtBQUNuRixvRUFBbUc7QUFNbkcsTUFBTSxZQUFZLEdBQUc7SUFDbkIsb0JBQW9CO0lBQ3BCLGtCQUFrQjtDQUNuQixDQUFDO0FBRUYsTUFBYSx1QkFBd0IsU0FBUSw0QkFBWTtJQUN2RCxZQUFZLE9BQXVDO1FBQ2pELE1BQU0sV0FBVyxHQUFHO1lBQ2xCLEdBQUcsT0FBTztZQUNWLElBQUksRUFBRSwrQkFBYyxDQUFDLENBQUMsR0FBRyxZQUFZLEVBQUUsR0FBRyxDQUFDLE9BQU8sQ0FBQyxJQUFJLElBQUksRUFBRSxDQUFDLENBQUMsQ0FBQztZQUNoRSxpQkFBaUIsRUFBRSx5QkFBUSxDQUFDLE9BQU8sQ0FBQyxnQkFBZ0IsQ0FBQztTQUN0RCxDQUFDO1FBQ0YsTUFBTSxFQUFFLE9BQU8sRUFBRSxXQUFXLEVBQUUsS0FBSyxFQUFFLEdBQUcsNkJBQVksQ0FBQyxXQUFXLEVBQUUsSUFBSSxDQUFDLElBQUksQ0FBQyxTQUFTLEVBQUUsVUFBVSxDQUFDLEVBQUUsSUFBSSxDQUFDLENBQUM7UUFDMUcsS0FBSyxDQUFDLFdBQVcsQ0FBQyxDQUFDO1FBQ25CLHlCQUFRLENBQUMsSUFBSSxFQUFFLEtBQUssQ0FBQyxDQUFDO1FBQ3RCLG1DQUFtQztJQUNyQyxDQUFDOztBQVhILDBEQVlDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0ICogYXMgcGF0aCBmcm9tICdwYXRoJztcbmltcG9ydCB7IENka3RmUHJvamVjdCwgQ2RrdGZQcm9qZWN0T3B0aW9ucyB9IGZyb20gJ0BybG1hcnRpbi1wcm9qZW4vY2RrdGYtcHJvamVjdCc7XG5pbXBvcnQgeyBhZGRGaWxlcywgYWxsQ2FzZXMsIGxvYWRTZXR0aW5ncywgc3F1YXNoUGFja2FnZXMgfSBmcm9tICdAcmxtYXJ0aW4tcHJvamVuL3Byb2plbi1wcm9qZWN0JztcblxuZXhwb3J0IGludGVyZmFjZSBTa2VwT3JnYW5pemF0aW9uUHJvamVjdE9wdGlvbnMgZXh0ZW5kcyBDZGt0ZlByb2plY3RPcHRpb25zIHtcbiAgcmVhZG9ubHkgb3JnYW5pemF0aW9uTmFtZTogc3RyaW5nO1xufVxuXG5jb25zdCBkZXBlbmRlbmNpZXMgPSBbXG4gICdAc2tlcHRvb2xzL3NrZXBAfjAnLFxuICAndGltZXpvbmUtZW51bUB+MScsXG5dO1xuXG5leHBvcnQgY2xhc3MgU2tlcE9yZ2FuaXphdGlvblByb2plY3QgZXh0ZW5kcyBDZGt0ZlByb2plY3Qge1xuICBjb25zdHJ1Y3RvcihvcHRpb25zOiBTa2VwT3JnYW5pemF0aW9uUHJvamVjdE9wdGlvbnMpIHtcbiAgICBjb25zdCB0ZW1wT3B0aW9ucyA9IHtcbiAgICAgIC4uLm9wdGlvbnMsXG4gICAgICBkZXBzOiBzcXVhc2hQYWNrYWdlcyhbLi4uZGVwZW5kZW5jaWVzLCAuLi4ob3B0aW9ucy5kZXBzIHx8IFtdKV0pLFxuICAgICAgX29yZ2FuaXphdGlvbk5hbWU6IGFsbENhc2VzKG9wdGlvbnMub3JnYW5pemF0aW9uTmFtZSksXG4gICAgfTtcbiAgICBjb25zdCB7IG9wdGlvbnM6IHByb2plY3RPcHRzLCBmaWxlcyB9ID0gbG9hZFNldHRpbmdzKHRlbXBPcHRpb25zLCBwYXRoLmpvaW4oX19kaXJuYW1lLCAnLi4vZmlsZXMnKSwgdHJ1ZSk7XG4gICAgc3VwZXIocHJvamVjdE9wdHMpO1xuICAgIGFkZEZpbGVzKHRoaXMsIGZpbGVzKTtcbiAgICAvLyBBZGQgbm9uLXRlbXBsYXRlZCByZXNvdXJjZXMgaGVyZVxuICB9XG59XG4iXX0=
package/package.json CHANGED
@@ -45,17 +45,16 @@
45
45
  "eslint-plugin-import": "^2.27.5",
46
46
  "jest": "^27",
47
47
  "jest-junit": "^13",
48
- "jsii": "^1.74.0",
49
- "jsii-diff": "^1.74.0",
50
- "jsii-docgen": "^7.0.218",
51
- "jsii-pacmak": "^1.74.0",
52
- "json-schema": "^0.4.0",
48
+ "jsii": "^1.76.0",
49
+ "jsii-diff": "^1.76.0",
50
+ "jsii-docgen": "^7.1.14",
51
+ "jsii-pacmak": "^1.76.0",
53
52
  "npm-check-updates": "^16",
54
53
  "projen": "^0.65.58",
55
54
  "standard-version": "^9",
56
55
  "ts-jest": "^27",
57
56
  "ts-node": "^10.9.1",
58
- "typescript": "^4.9.4"
57
+ "typescript": "^4.9.5"
59
58
  },
60
59
  "peerDependencies": {
61
60
  "@rlmartin-projen/cdktf-project": "~0",
@@ -76,7 +75,7 @@
76
75
  "publishConfig": {
77
76
  "access": "public"
78
77
  },
79
- "version": "0.0.11",
78
+ "version": "0.0.12",
80
79
  "jest": {
81
80
  "testMatch": [
82
81
  "<rootDir>/src/**/__tests__/**/*.ts?(x)",