@skeptools/skep-organization-project 0.0.4 → 0.0.5

package/.jsii

@@ -167,6 +167,6 @@
       "symbolId": "src/skep-organization-project:SkepOrganizationProjectOptions"
     }
   },
-  "version": "0.0.4",
-  "fingerprint": "w4fHhImRmUNyYoKJWh2AYwBcMO5GQOP37pjsIIUNonk="
+  "version": "0.0.5",
+  "fingerprint": "nNe+H64ohvDkzE/FBmSFD/+jAPuyoL+1uLqs4XBByJs="
 }

package/API.md

@@ -149,12 +149,16 @@ const skepOrganizationProjectOptions: SkepOrganizationProjectOptions = { ... }
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name of the development tsconfig.json file. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
-| <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.enabledEnvs">enabledEnvs</a></code> | <code>string[]</code> | Add GitHub Wokflows for enabled environments. |
+| <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. |
+| <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. |
 | <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. |
-| <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.repoAdmins">repoAdmins</a></code> | <code>string[]</code> | The GitHub Team slug (including the org_name/ prefix) or GitHub username for the teams/people who maintain infrastructure. |
+| <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. |
+| <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. |
+| <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.terraformBackend">terraformBackend</a></code> | <code>@rlmartin-projen/cdktf-project.TerraformBackend</code> | Terraform backend configuration. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.terraformModules">terraformModules</a></code> | <code>@rlmartin-projen/cdktf-project.TerraformModuleOptions[]</code> | Terraform Modules to add to cdktf.json. These are assumed to be internal to the Medly GitHub org. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.terraformModulesSsh">terraformModulesSsh</a></code> | <code>boolean</code> | Set this to true for local dev when using SSH to connect to GitHub. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.terraformProviders">terraformProviders</a></code> | <code>string[]</code> | Terraform Providers to add to cdktf.json. |
+| <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.terraformVars">terraformVars</a></code> | <code>string[]</code> | List of Terraform variables to pull from GitHub secrets and set as TF_VAR_ environment variables during terraform plan. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.organizationName">organizationName</a></code> | <code>string</code> | *No description.* |
 
 ---
@@ -2036,14 +2040,27 @@ same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`).
 
 ---
 
-##### `enabledEnvs`<sup>Optional</sup> <a name="enabledEnvs" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.enabledEnvs"></a>
+##### `artifactsFolder`<sup>Optional</sup> <a name="artifactsFolder" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.artifactsFolder"></a>
 
 ```typescript
-public readonly enabledEnvs: string[];
+public readonly artifactsFolder: string;
 ```
 
-- *Type:* string[]
-- *Default:* []
+- *Type:* string
+- *Default:* 'dist'
+
+Configurable folder for artifacts to package when transitioning from plan to apply.
+
+---
+
+##### `deploymentEnvironments`<sup>Optional</sup> <a name="deploymentEnvironments" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.deploymentEnvironments"></a>
+
+```typescript
+public readonly deploymentEnvironments: {[ key: string ]: DeploymentEnvironment};
+```
+
+- *Type:* {[ key: string ]: @rlmartin-projen/cdktf-project.DeploymentEnvironment}
+- *Default:* {}
 
 Add GitHub Wokflows for enabled environments.
 
@@ -2062,17 +2079,47 @@ A set of scripts to be added to package.json but not wrapped by projen.
 
 ---
 
-##### `repoAdmins`<sup>Optional</sup> <a name="repoAdmins" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.repoAdmins"></a>
+##### `npmrc`<sup>Optional</sup> <a name="npmrc" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.npmrc"></a>
 
 ```typescript
-public readonly repoAdmins: string[];
+public readonly npmrc: string[];
 ```
 
 - *Type:* string[]
 - *Default:* []
 
+Raw lines to drop into the workflow's .npmrc file, to access private package. Empty implies no .npmrc required.
+
+---
+
+##### `repoAdmins`<sup>Optional</sup> <a name="repoAdmins" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.repoAdmins"></a>
+
+```typescript
+public readonly repoAdmins: {[ key: string ]: number};
+```
+
+- *Type:* {[ key: string ]: number}
+- *Default:* {}
+
 The GitHub Team slug (including the org_name/ prefix) or GitHub username for the teams/people who maintain infrastructure.
 
+As a hack, and to avoid async fetching from the GitHub API to lookup ids, this is a map of
+username => GitHub id (which will need to be looked up manually). In the future it would be
+nice to make this a simple string[] (list of usernames) and automatically lookup the ids.
+
+---
+
+##### `terraformBackend`<sup>Optional</sup> <a name="terraformBackend" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.terraformBackend"></a>
+
+```typescript
+public readonly terraformBackend: TerraformBackend;
+```
+
+- *Type:* @rlmartin-projen/cdktf-project.TerraformBackend
+- *Default:* S3Backend
+
+Terraform backend configuration.
+
 ---
 
 ##### `terraformModules`<sup>Optional</sup> <a name="terraformModules" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.terraformModules"></a>
@@ -2114,6 +2161,23 @@ Terraform Providers to add to cdktf.json.
 
 ---
 
+##### `terraformVars`<sup>Optional</sup> <a name="terraformVars" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.terraformVars"></a>
+
+```typescript
+public readonly terraformVars: string[];
+```
+
+- *Type:* string[]
+- *Default:* []
+
+List of Terraform variables to pull from GitHub secrets and set as TF_VAR_ environment variables during terraform plan.
+
+The secrets will need to be set
+manually, on one of org/repo/environment. The name of the var is expected to
+not include the TF_VAR_ prefix.
+
+---
+
 ##### `organizationName`<sup>Required</sup> <a name="organizationName" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.organizationName"></a>
 
 ```typescript

package/lib/skep-organization-project.js

@@ -20,5 +20,5 @@ class SkepOrganizationProject extends cdktf_project_1.CdktfProject {
 }
 exports.SkepOrganizationProject = SkepOrganizationProject;
 _a = JSII_RTTI_SYMBOL_1;
-SkepOrganizationProject[_a] = { fqn: "@skeptools/skep-organization-project.SkepOrganizationProject", version: "0.0.4" };
+SkepOrganizationProject[_a] = { fqn: "@skeptools/skep-organization-project.SkepOrganizationProject", version: "0.0.5" };
 //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2tlcC1vcmdhbml6YXRpb24tcHJvamVjdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9za2VwLW9yZ2FuaXphdGlvbi1wcm9qZWN0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBQUEsNkJBQTZCO0FBQzdCLGtFQUFtRjtBQUNuRixvRUFBbUY7QUFNbkYsTUFBYSx1QkFBd0IsU0FBUSw0QkFBWTtJQUN2RCxZQUFZLE9BQXVDO1FBQ2pELE1BQU0sV0FBVyxHQUFHO1lBQ2xCLEdBQUcsT0FBTztZQUNWLGlCQUFpQixFQUFFLHlCQUFRLENBQUMsT0FBTyxDQUFDLGdCQUFnQixDQUFDO1NBQ3RELENBQUM7UUFDRixNQUFNLEVBQUUsT0FBTyxFQUFFLFdBQVcsRUFBRSxLQUFLLEVBQUUsR0FBRyw2QkFBWSxDQUFDLFdBQVcsRUFBRSxJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsRUFBRSxVQUFVLENBQUMsRUFBRSxJQUFJLENBQUMsQ0FBQztRQUMxRyxLQUFLLENBQUMsV0FBVyxDQUFDLENBQUM7UUFDbkIseUJBQVEsQ0FBQyxJQUFJLEVBQUUsS0FBSyxDQUFDLENBQUM7UUFDdEIsbUNBQW1DO0lBQ3JDLENBQUM7O0FBVkgsMERBV0MiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgKiBhcyBwYXRoIGZyb20gJ3BhdGgnO1xuaW1wb3J0IHsgQ2RrdGZQcm9qZWN0LCBDZGt0ZlByb2plY3RPcHRpb25zIH0gZnJvbSAnQHJsbWFydGluLXByb2plbi9jZGt0Zi1wcm9qZWN0JztcbmltcG9ydCB7IGFkZEZpbGVzLCBhbGxDYXNlcywgbG9hZFNldHRpbmdzIH0gZnJvbSAnQHJsbWFydGluLXByb2plbi9wcm9qZW4tcHJvamVjdCc7XG5cbmV4cG9ydCBpbnRlcmZhY2UgU2tlcE9yZ2FuaXphdGlvblByb2plY3RPcHRpb25zIGV4dGVuZHMgQ2RrdGZQcm9qZWN0T3B0aW9ucyB7XG4gIHJlYWRvbmx5IG9yZ2FuaXphdGlvbk5hbWU6IHN0cmluZztcbn1cblxuZXhwb3J0IGNsYXNzIFNrZXBPcmdhbml6YXRpb25Qcm9qZWN0IGV4dGVuZHMgQ2RrdGZQcm9qZWN0IHtcbiAgY29uc3RydWN0b3Iob3B0aW9uczogU2tlcE9yZ2FuaXphdGlvblByb2plY3RPcHRpb25zKSB7XG4gICAgY29uc3QgdGVtcE9wdGlvbnMgPSB7XG4gICAgICAuLi5vcHRpb25zLFxuICAgICAgX29yZ2FuaXphdGlvbk5hbWU6IGFsbENhc2VzKG9wdGlvbnMub3JnYW5pemF0aW9uTmFtZSksXG4gICAgfTtcbiAgICBjb25zdCB7IG9wdGlvbnM6IHByb2plY3RPcHRzLCBmaWxlcyB9ID0gbG9hZFNldHRpbmdzKHRlbXBPcHRpb25zLCBwYXRoLmpvaW4oX19kaXJuYW1lLCAnLi4vZmlsZXMnKSwgdHJ1ZSk7XG4gICAgc3VwZXIocHJvamVjdE9wdHMpO1xuICAgIGFkZEZpbGVzKHRoaXMsIGZpbGVzKTtcbiAgICAvLyBBZGQgbm9uLXRlbXBsYXRlZCByZXNvdXJjZXMgaGVyZVxuICB9XG59XG4iXX0=

package/package.json

@@ -47,7 +47,7 @@
     "jest-junit": "^13",
     "jsii": "^1.72.0",
     "jsii-diff": "^1.72.0",
-    "jsii-docgen": "^7.0.179",
+    "jsii-docgen": "^7.0.180",
     "jsii-pacmak": "^1.72.0",
     "json-schema": "^0.4.0",
     "npm-check-updates": "^16",
@@ -76,7 +76,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.0.4",
+  "version": "0.0.5",
   "jest": {
     "testMatch": [
       "<rootDir>/src/**/__tests__/**/*.ts?(x)",