@skeptools/skep-organization-project 0.0.5 → 0.0.7

package/.jsii

@@ -86,7 +86,7 @@
   },
   "name": "@skeptools/skep-organization-project",
   "readme": {
-    "markdown": "# skep-organization-project\n\n## Usage\n```\nnpx projen new \\\n  --from @skeptools/skep-organization-project \\\n  --organization-name \"Foo Company\" \\\n  --projenrcts\n```\n"
+    "markdown": "# skep-organization-project\n\n## Usage\n```\nnvm use 14\nnpx projen new \\\n  --from @skeptools/skep-organization-project \\\n  --organization-name \"Foo Company\" \\\n  --projenrcts\n```\n"
   },
   "repository": {
     "type": "git",
@@ -112,7 +112,7 @@
         },
         "locationInModule": {
           "filename": "src/skep-organization-project.ts",
-          "line": 10
+          "line": 15
         },
         "parameters": [
           {
@@ -126,7 +126,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/skep-organization-project.ts",
-        "line": 9
+        "line": 14
       },
       "name": "SkepOrganizationProject",
       "symbolId": "src/skep-organization-project:SkepOrganizationProject"
@@ -167,6 +167,6 @@
       "symbolId": "src/skep-organization-project:SkepOrganizationProjectOptions"
     }
   },
-  "version": "0.0.5",
-  "fingerprint": "nNe+H64ohvDkzE/FBmSFD/+jAPuyoL+1uLqs4XBByJs="
+  "version": "0.0.7",
+  "fingerprint": "Yz4ZBvqpvMIyNxMVKg7ZpJZvnC5+6oheUyfpYODZBwI="
 }

package/README.md

@@ -2,6 +2,7 @@
 
 ## Usage
 ```
+nvm use 14
 npx projen new \
   --from @skeptools/skep-organization-project \
   --organization-name "Foo Company" \

package/files/scaffolding/README.md.liquid

@@ -12,32 +12,13 @@ TF_WORKSPACE=prod terraform plan -out=prod.tfplan
 terraform apply prod.tfplan
 ```
 
-## Adding new people and teams
-There are a couple yarn commands you can use to add new people.
-
-To create a new `config` file for a person, run:
-
-```
-  yarn add-person {firstName} {lastName}
-```
-
-This will create a new src/config/people/first_last.ts file. The name of the manager should also be in the same format, i.e., manager: "first_last". The team file src/config/teams/team_name.ts *must* be added with the new team member with the pattern set in that file.
-
-To create a new `config` file for a team, run:
-
-```
-  yarn add-team {teamName}
-```
-
-To re-generate composite `people` files for use in a `Team` config file plus composite `team` files, run:
-
-```
-  yarn regen
-```
-
-To clean re-generated files using `regen`, run:
-
-```
-  yarn regen:clean
-```
-
+## Bootstrapping
+* Define your `SkepStack` in [src/stack.ts](./src/stack.ts). This will include:
+  * Adding plugins to `deps` in `.projenrc.ts` for any necessary integrations, re-running `npx projen`.
+  * Adding any necessary [Integrations](./src/stack.ts#L16) to the definition.
+  * Adding [loading code](./src/stack.ts#L42-L50) for those integrations.
+  * Adding all provider variables for those integrations to `.projenrc.ts`, re-running `npx projen`.
+  * Adding GitHub secrets to the repo for all provider variables defined above.
+* Add [person config](./src/config/people) for each person in the org; make sure to add them to [index.ts](./src/config/people/index.ts).
+* Add [team config](./src/config/teams) for each team in the org; make sure to add them to [index.ts](./src/config/teams/index.ts).
+* Delete this section when complete.

package/files/scaffolding/src/config/organization/index.ts.liquid

@@ -0,0 +1,8 @@
+import { OrganizationProps } from '@skeptools/skep-core';
+import { {{ _organizationName.pascal }}Integrations } from '../../stack';
+
+export const organization: OrganizationProps<{{ _organizationName.pascal }}Integrations> = {
+  name: '{{ _organizationName.title }}',
+  integrations: {
+  },
+};

package/files/scaffolding/src/config/people/index.ts

@@ -0,0 +1,2 @@
+export * from './janeDoe'
+export * from './johnDoe'

package/files/scaffolding/src/config/teams/index.ts

@@ -0,0 +1 @@
+export * from './foorBar'

package/files/scaffolding/src/stack.ts.liquid

@@ -0,0 +1,58 @@
+import { Factory as GitHubFactory } from '@skeptools/plugin-github';
+import { OrganizationProps, PersonProps, SkepStack, TeamProps } from '@skeptools/skep-core';
+import { RoleType, TeamType } from '@skeptools/skep';
+import { organization } from './config/organization';
+import * as people from './config/people';
+import * as teams from './config/teams';
+import { Construct } from 'constructs';
+import { Environments } from './environments';
+import { TerraformStack } from 'cdktf';
+
+export type PeopleKeys = Extract<keyof typeof people, string>;
+export type TeamKeys = Extract<keyof typeof teams, string>;
+export type {{ _organizationName.pascal }}Integrations = Integrations<PeopleKeys>;
+
+export interface Integrations<PeopleKeys extends string> {
+  readonly github: GitHubFactory<PeopleKeys, TeamType, RoleType>;
+}
+
+export class {{ _organizationName.pascal }}Stack<
+  PeopleKeys extends string,
+  TeamKeys extends string
+> extends SkepStack<
+  Integrations<PeopleKeys>,
+  PeopleKeys,
+  TeamKeys,
+  TeamType,
+  RoleType
+  > {
+  get defaultConfig() {
+    return {
+      team: {
+        type: 'team' as TeamType,
+      },
+    };
+  }
+
+  load(
+    orgConfig: OrganizationProps<Integrations<PeopleKeys>>,
+    peopleConfig: Record<PeopleKeys, PersonProps<Integrations<PeopleKeys>, RoleType>>,
+    teamConfig: Record<TeamKeys, TeamProps<Integrations<PeopleKeys>, PeopleKeys, TeamType>>,
+  ): Integrations<PeopleKeys> {
+    const github = new GitHubFactory<PeopleKeys, TeamType, RoleType>(
+      this,
+      'github',
+      this.getOrganizationConfig(orgConfig, 'github'),
+      this.getPersonConfig(peopleConfig, 'github'),
+      this.getTeamConfig(teamConfig, 'github'),
+    );
+    github.load();
+    return { github };
+  }
+}
+
+export const pushStacks = (scope: Construct): Environments<TerraformStack> => {
+  return {
+    'prod': new {{ _organizationName.pascal }}Stack<PeopleKeys, TeamKeys>(scope, 'prod', organization, people, teams),
+  }
+}

package/lib/skep-organization-project.js

@@ -6,10 +6,15 @@ const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
 const path = require("path");
 const cdktf_project_1 = require("@rlmartin-projen/cdktf-project");
 const projen_project_1 = require("@rlmartin-projen/projen-project");
+const dependencies = [
+    '@skeptools/skep@~0',
+    'timezone-enum@~1',
+];
 class SkepOrganizationProject extends cdktf_project_1.CdktfProject {
     constructor(options) {
         const tempOptions = {
             ...options,
+            deps: projen_project_1.squashPackages([...dependencies, ...(options.deps || [])]),
             _organizationName: projen_project_1.allCases(options.organizationName),
         };
         const { options: projectOpts, files } = projen_project_1.loadSettings(tempOptions, path.join(__dirname, '../files'), true);
@@ -20,5 +25,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.5" };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2tlcC1vcmdhbml6YXRpb24tcHJvamVjdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9za2VwLW9yZ2FuaXphdGlvbi1wcm9qZWN0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBQUEsNkJBQTZCO0FBQzdCLGtFQUFtRjtBQUNuRixvRUFBbUY7QUFNbkYsTUFBYSx1QkFBd0IsU0FBUSw0QkFBWTtJQUN2RCxZQUFZLE9BQXVDO1FBQ2pELE1BQU0sV0FBVyxHQUFHO1lBQ2xCLEdBQUcsT0FBTztZQUNWLGlCQUFpQixFQUFFLHlCQUFRLENBQUMsT0FBTyxDQUFDLGdCQUFnQixDQUFDO1NBQ3RELENBQUM7UUFDRixNQUFNLEVBQUUsT0FBTyxFQUFFLFdBQVcsRUFBRSxLQUFLLEVBQUUsR0FBRyw2QkFBWSxDQUFDLFdBQVcsRUFBRSxJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsRUFBRSxVQUFVLENBQUMsRUFBRSxJQUFJLENBQUMsQ0FBQztRQUMxRyxLQUFLLENBQUMsV0FBVyxDQUFDLENBQUM7UUFDbkIseUJBQVEsQ0FBQyxJQUFJLEVBQUUsS0FBSyxDQUFDLENBQUM7UUFDdEIsbUNBQW1DO0lBQ3JDLENBQUM7O0FBVkgsMERBV0MiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgKiBhcyBwYXRoIGZyb20gJ3BhdGgnO1xuaW1wb3J0IHsgQ2RrdGZQcm9qZWN0LCBDZGt0ZlByb2plY3RPcHRpb25zIH0gZnJvbSAnQHJsbWFydGluLXByb2plbi9jZGt0Zi1wcm9qZWN0JztcbmltcG9ydCB7IGFkZEZpbGVzLCBhbGxDYXNlcywgbG9hZFNldHRpbmdzIH0gZnJvbSAnQHJsbWFydGluLXByb2plbi9wcm9qZW4tcHJvamVjdCc7XG5cbmV4cG9ydCBpbnRlcmZhY2UgU2tlcE9yZ2FuaXphdGlvblByb2plY3RPcHRpb25zIGV4dGVuZHMgQ2RrdGZQcm9qZWN0T3B0aW9ucyB7XG4gIHJlYWRvbmx5IG9yZ2FuaXphdGlvbk5hbWU6IHN0cmluZztcbn1cblxuZXhwb3J0IGNsYXNzIFNrZXBPcmdhbml6YXRpb25Qcm9qZWN0IGV4dGVuZHMgQ2RrdGZQcm9qZWN0IHtcbiAgY29uc3RydWN0b3Iob3B0aW9uczogU2tlcE9yZ2FuaXphdGlvblByb2plY3RPcHRpb25zKSB7XG4gICAgY29uc3QgdGVtcE9wdGlvbnMgPSB7XG4gICAgICAuLi5vcHRpb25zLFxuICAgICAgX29yZ2FuaXphdGlvbk5hbWU6IGFsbENhc2VzKG9wdGlvbnMub3JnYW5pemF0aW9uTmFtZSksXG4gICAgfTtcbiAgICBjb25zdCB7IG9wdGlvbnM6IHByb2plY3RPcHRzLCBmaWxlcyB9ID0gbG9hZFNldHRpbmdzKHRlbXBPcHRpb25zLCBwYXRoLmpvaW4oX19kaXJuYW1lLCAnLi4vZmlsZXMnKSwgdHJ1ZSk7XG4gICAgc3VwZXIocHJvamVjdE9wdHMpO1xuICAgIGFkZEZpbGVzKHRoaXMsIGZpbGVzKTtcbiAgICAvLyBBZGQgbm9uLXRlbXBsYXRlZCByZXNvdXJjZXMgaGVyZVxuICB9XG59XG4iXX0=
+SkepOrganizationProject[_a] = { fqn: "@skeptools/skep-organization-project.SkepOrganizationProject", version: "0.0.7" };
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2tlcC1vcmdhbml6YXRpb24tcHJvamVjdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9za2VwLW9yZ2FuaXphdGlvbi1wcm9qZWN0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBQUEsNkJBQTZCO0FBQzdCLGtFQUFtRjtBQUNuRixvRUFBbUc7QUFNbkcsTUFBTSxZQUFZLEdBQUc7SUFDbkIsb0JBQW9CO0lBQ3BCLGtCQUFrQjtDQUNuQixDQUFDO0FBRUYsTUFBYSx1QkFBd0IsU0FBUSw0QkFBWTtJQUN2RCxZQUFZLE9BQXVDO1FBQ2pELE1BQU0sV0FBVyxHQUFHO1lBQ2xCLEdBQUcsT0FBTztZQUNWLElBQUksRUFBRSwrQkFBYyxDQUFDLENBQUMsR0FBRyxZQUFZLEVBQUUsR0FBRyxDQUFDLE9BQU8sQ0FBQyxJQUFJLElBQUksRUFBRSxDQUFDLENBQUMsQ0FBQztZQUNoRSxpQkFBaUIsRUFBRSx5QkFBUSxDQUFDLE9BQU8sQ0FBQyxnQkFBZ0IsQ0FBQztTQUN0RCxDQUFDO1FBQ0YsTUFBTSxFQUFFLE9BQU8sRUFBRSxXQUFXLEVBQUUsS0FBSyxFQUFFLEdBQUcsNkJBQVksQ0FBQyxXQUFXLEVBQUUsSUFBSSxDQUFDLElBQUksQ0FBQyxTQUFTLEVBQUUsVUFBVSxDQUFDLEVBQUUsSUFBSSxDQUFDLENBQUM7UUFDMUcsS0FBSyxDQUFDLFdBQVcsQ0FBQyxDQUFDO1FBQ25CLHlCQUFRLENBQUMsSUFBSSxFQUFFLEtBQUssQ0FBQyxDQUFDO1FBQ3RCLG1DQUFtQztJQUNyQyxDQUFDOztBQVhILDBEQVlDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0ICogYXMgcGF0aCBmcm9tICdwYXRoJztcbmltcG9ydCB7IENka3RmUHJvamVjdCwgQ2RrdGZQcm9qZWN0T3B0aW9ucyB9IGZyb20gJ0BybG1hcnRpbi1wcm9qZW4vY2RrdGYtcHJvamVjdCc7XG5pbXBvcnQgeyBhZGRGaWxlcywgYWxsQ2FzZXMsIGxvYWRTZXR0aW5ncywgc3F1YXNoUGFja2FnZXMgfSBmcm9tICdAcmxtYXJ0aW4tcHJvamVuL3Byb2plbi1wcm9qZWN0JztcblxuZXhwb3J0IGludGVyZmFjZSBTa2VwT3JnYW5pemF0aW9uUHJvamVjdE9wdGlvbnMgZXh0ZW5kcyBDZGt0ZlByb2plY3RPcHRpb25zIHtcbiAgcmVhZG9ubHkgb3JnYW5pemF0aW9uTmFtZTogc3RyaW5nO1xufVxuXG5jb25zdCBkZXBlbmRlbmNpZXMgPSBbXG4gICdAc2tlcHRvb2xzL3NrZXBAfjAnLFxuICAndGltZXpvbmUtZW51bUB+MScsXG5dO1xuXG5leHBvcnQgY2xhc3MgU2tlcE9yZ2FuaXphdGlvblByb2plY3QgZXh0ZW5kcyBDZGt0ZlByb2plY3Qge1xuICBjb25zdHJ1Y3RvcihvcHRpb25zOiBTa2VwT3JnYW5pemF0aW9uUHJvamVjdE9wdGlvbnMpIHtcbiAgICBjb25zdCB0ZW1wT3B0aW9ucyA9IHtcbiAgICAgIC4uLm9wdGlvbnMsXG4gICAgICBkZXBzOiBzcXVhc2hQYWNrYWdlcyhbLi4uZGVwZW5kZW5jaWVzLCAuLi4ob3B0aW9ucy5kZXBzIHx8IFtdKV0pLFxuICAgICAgX29yZ2FuaXphdGlvbk5hbWU6IGFsbENhc2VzKG9wdGlvbnMub3JnYW5pemF0aW9uTmFtZSksXG4gICAgfTtcbiAgICBjb25zdCB7IG9wdGlvbnM6IHByb2plY3RPcHRzLCBmaWxlcyB9ID0gbG9hZFNldHRpbmdzKHRlbXBPcHRpb25zLCBwYXRoLmpvaW4oX19kaXJuYW1lLCAnLi4vZmlsZXMnKSwgdHJ1ZSk7XG4gICAgc3VwZXIocHJvamVjdE9wdHMpO1xuICAgIGFkZEZpbGVzKHRoaXMsIGZpbGVzKTtcbiAgICAvLyBBZGQgbm9uLXRlbXBsYXRlZCByZXNvdXJjZXMgaGVyZVxuICB9XG59XG4iXX0=

package/package.json

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