projen-cdktf-hybrid-construct 0.1.49 → 0.1.52

package/.projenrc.ts

@@ -13,7 +13,7 @@ const project = new typescript.TypeScriptProject({
   license: "MIT",
   copyrightOwner: "Daniel Schmidt",
 
-  deps: ["projen", "@types/uuid", "uuid"],
+  deps: ["projen", "@types/uuid", "uuid", "@types/change-case", "change-case"],
   devDeps: ["fs-extra", "glob", "@types/fs-extra", "@types/glob"],
 
   release: true,

package/README.md

@@ -21,7 +21,6 @@ If you want to write a CDKTF construct and also publish it as a Terraform Module
 const { HybridModule } = require("projen-cdktf-hybrid-construct");
 
 const project = new HybridModule({
-  defaultReleaseBranch: "main",
   // The name of the module & repository need to start with terraform-cdk-
   name: "terraform-cdk-my-new-hybrid-construct",
   repositoryUrl:
@@ -68,7 +67,7 @@ project.synth();
 If you want to republish an existing Terraform module as a CDKTF construct or if you want to repackage them with an easier to use API you can use the `TerraformModule` template.
 
 ```js
-const { HybridModule } = require("projen-cdktf-hybrid-construct");
+const { TerraformModule } = require("projen-cdktf-hybrid-construct");
 
 const project = new TerraformModule({
   name: "my-module",
@@ -93,6 +92,106 @@ const project = new TerraformModule({
 project.synth();
 ```
 
+## Publishing
+
+### Open Source
+
+We have a helper method for easy configuration, but there are still some manual steps required.
+
+```js
+const {
+  HybridModule,
+  publishToRegistries,
+} = require("projen-cdktf-hybrid-construct");
+
+const project = new HybridModule({
+  // ... all the other options
+  ...publishToRegistries({
+    name: "my-new-hybrid-construct",
+    namespace: "my-org",
+    registries: ["npm", "pypi", "nuget", "maven"],
+  }),
+});
+```
+
+#### Terraform
+
+1. [Sign in at the registry](https://registry.terraform.io/sign-in)
+2. [Select your repository](https://registry.terraform.io/github/create) and create the module
+
+Please make sure your repository name starts with `terraform-cdk-`.
+
+#### npm (Typescript)
+
+1. Create an account at [npmjs.com](https://npmjs.com/)
+2. Create an [automation token](https://docs.npmjs.com/creating-and-viewing-access-tokens) on npm
+3. Create a [GitHub Action Secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) with the name `NPM_TOKEN` and the value of the token
+
+#### pypi (Python)
+
+1. Create an account at [pypi.org](https://pypi.org/)
+2. Create an [API token](https://pypi.org/help/#apitoken) on pypi
+3. Create a [GitHub Action Secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) with the name `TWINE_USERNAME` and the value `__token__` and a second one with the name `TWINE_PASSWORD` and the value of the token
+4. Set the `publishToPypi` section in the options of `HybridModule` or `TerraformModule` (or use the helper mentioned above)
+
+```js
+const name = "name-of-my-hybrid-construct";
+new HybridModule({
+  name,
+  // ... other options
+  publishToPypi: {
+    distName: name,
+    module: name.replace(/-/g, "_"),
+  },
+});
+```
+
+#### Maven (Java)
+
+1. [Create a Sonatype account and repository](https://central.sonatype.org/publish/publish-guide/#introduction)
+2. Create [GitHub Action Secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) to configure maven:
+   - `MAVEN_USERNAME`
+   - `MAVEN_PASSWORD`
+   - `MAVEN_STAGING_PROFILE_ID`
+   - `MAVEN_GPG_PRIVATE_KEY_PASSPHRASE`
+   - `MAVEN_GPG_PRIVATE_KEY_PASSPHRASE`
+3. Setup the `publishToMaven` section in the options of `HybridModule` or `TerraformModule` (or use the helper mentioned above)
+
+```js
+const githubNamespace = "my-org";
+const name = "name-of-my-hybrid-construct";
+new HybridModule({
+  name,
+  // ... other options
+  publishToMaven: {
+    javaPackage: name.replace(/-/g, "_"),
+    mavenGroupId: `com.${githubNamespace}`,
+    mavenArtifactId: name,
+  },
+});
+```
+
+#### NuGet (C#)
+
+1. [Create a NuGet account](https://www.nuget.org/users/account/LogOn) (you might need to create a Microsoft Account if you don't have one)
+2. [Create API keys](https://docs.microsoft.com/en-us/nuget/nuget-org/publish-a-package#create-api-keys)
+3. Create a [GitHub Action Secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) with the name `NUGET_API_KEY` and the value of the token
+4. Setup the `publishToNuget` section in the options of `HybridModule` or `TerraformModule` (or use the helper mentioned above)
+
+```js
+const githubNamespace = "my-org";
+const name = "name-of-my-hybrid-construct";
+
+new HybridModule({
+  name,
+  // ... other options
+  publishToNuget: {
+    dotNetNamespace: `MyOrg.NameOfMyHybridConstruct`,
+    packageId: `MyOrg.NameOfMyHybridConstruct`,
+  },
+});
+```
+
 ### Roadmap
 
 - [x] Add dedicated file for HCL templates
@@ -101,8 +200,6 @@ project.synth();
 - [x] [Auto-generate parts of the docs](https://github.com/terraform-aws-modules/terraform-aws-eks/blob/e90c877a741ab3cc4215376a70f7bcc360b6a3d2/.github/workflows/pre-commit.yml)
 - [x] Add example folder to project using this
 - [x] Add testing strategy
+- [x] Add construct / option / docs to publish existing module as construct
 - [ ] Add deployment scripts to Artifactory
 - [ ] Add deployment scripts to Github Packages
-- [x] Add construct / option / docs to publish existing module as construct
-- [ ] Add construct for managing multiple repos like this
-- [ ] Add option to manager projen template to bootstrap cdktf app that deploys Artifactory?

package/lib/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./hybrid-module";
 export * from "./terraform-module";
+export * from "./publishing";

package/lib/index.js

@@ -16,4 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./hybrid-module"), exports);
 __exportStar(require("./terraform-module"), exports);
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLGtEQUFnQztBQUNoQyxxREFBbUMiLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgKiBmcm9tIFwiLi9oeWJyaWQtbW9kdWxlXCI7XG5leHBvcnQgKiBmcm9tIFwiLi90ZXJyYWZvcm0tbW9kdWxlXCI7XG4iXX0=
+__exportStar(require("./publishing"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLGtEQUFnQztBQUNoQyxxREFBbUM7QUFDbkMsK0NBQTZCIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0ICogZnJvbSBcIi4vaHlicmlkLW1vZHVsZVwiO1xuZXhwb3J0ICogZnJvbSBcIi4vdGVycmFmb3JtLW1vZHVsZVwiO1xuZXhwb3J0ICogZnJvbSBcIi4vcHVibGlzaGluZ1wiO1xuIl19

package/lib/publishing.d.ts

@@ -0,0 +1,13 @@
+import { ConstructLibraryOptions } from "projen/lib/cdk";
+export declare type Registry = "npm" | "maven" | "nuget" | "pypi";
+export declare type PublishOptions = {
+    name: string;
+    namespace: string;
+    registries: Registry[];
+};
+declare type Mutable<T> = {
+    -readonly [k in keyof T]: T[k];
+};
+declare type Config = Mutable<Pick<ConstructLibraryOptions, "publishToPypi" | "publishToMaven" | "publishToNuget" | "releaseToNpm">>;
+export declare function publishToRegistries(options: PublishOptions): Config;
+export {};

package/lib/publishing.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.publishToRegistries = void 0;
+const change_case_1 = require("change-case");
+function publishToRegistries(options) {
+    const { name, namespace, registries } = options;
+    const sanitizedNamespace = namespace.replace(/-/gi, "_");
+    const sanitizedName = name.replace(/-/gi, "_");
+    const config = {
+        releaseToNpm: registries.includes("npm"),
+    };
+    if (registries.includes("pypi")) {
+        config.publishToPypi = {
+            distName: `${sanitizedNamespace}-${sanitizedName}`,
+            module: `${sanitizedNamespace}_${sanitizedName}`,
+        };
+    }
+    if (registries.includes("maven")) {
+        config.publishToMaven = {
+            javaPackage: `com.${sanitizedNamespace}.${sanitizedName}`,
+            mavenGroupId: `com.${sanitizedNamespace}`,
+            mavenArtifactId: sanitizedName,
+        };
+    }
+    if (registries.includes("nuget")) {
+        const nugetName = `${(0, change_case_1.pascalCase)(namespace)}.${(0, change_case_1.pascalCase)(name)}`;
+        config.publishToNuget = {
+            dotNetNamespace: nugetName,
+            packageId: nugetName,
+        };
+    }
+    return config;
+}
+exports.publishToRegistries = publishToRegistries;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHVibGlzaGluZy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9wdWJsaXNoaW5nLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLDZDQUF5QztBQXFCekMsU0FBZ0IsbUJBQW1CLENBQUMsT0FBdUI7SUFDekQsTUFBTSxFQUFFLElBQUksRUFBRSxTQUFTLEVBQUUsVUFBVSxFQUFFLEdBQUcsT0FBTyxDQUFDO0lBQ2hELE1BQU0sa0JBQWtCLEdBQUcsU0FBUyxDQUFDLE9BQU8sQ0FBQyxLQUFLLEVBQUUsR0FBRyxDQUFDLENBQUM7SUFDekQsTUFBTSxhQUFhLEdBQUcsSUFBSSxDQUFDLE9BQU8sQ0FBQyxLQUFLLEVBQUUsR0FBRyxDQUFDLENBQUM7SUFDL0MsTUFBTSxNQUFNLEdBQVc7UUFDckIsWUFBWSxFQUFFLFVBQVUsQ0FBQyxRQUFRLENBQUMsS0FBSyxDQUFDO0tBQ3pDLENBQUM7SUFFRixJQUFJLFVBQVUsQ0FBQyxRQUFRLENBQUMsTUFBTSxDQUFDLEVBQUU7UUFDL0IsTUFBTSxDQUFDLGFBQWEsR0FBRztZQUNyQixRQUFRLEVBQUUsR0FBRyxrQkFBa0IsSUFBSSxhQUFhLEVBQUU7WUFDbEQsTUFBTSxFQUFFLEdBQUcsa0JBQWtCLElBQUksYUFBYSxFQUFFO1NBQ2pELENBQUM7S0FDSDtJQUNELElBQUksVUFBVSxDQUFDLFFBQVEsQ0FBQyxPQUFPLENBQUMsRUFBRTtRQUNoQyxNQUFNLENBQUMsY0FBYyxHQUFHO1lBQ3RCLFdBQVcsRUFBRSxPQUFPLGtCQUFrQixJQUFJLGFBQWEsRUFBRTtZQUN6RCxZQUFZLEVBQUUsT0FBTyxrQkFBa0IsRUFBRTtZQUN6QyxlQUFlLEVBQUUsYUFBYTtTQUMvQixDQUFDO0tBQ0g7SUFDRCxJQUFJLFVBQVUsQ0FBQyxRQUFRLENBQUMsT0FBTyxDQUFDLEVBQUU7UUFDaEMsTUFBTSxTQUFTLEdBQUcsR0FBRyxJQUFBLHdCQUFVLEVBQUMsU0FBUyxDQUFDLElBQUksSUFBQSx3QkFBVSxFQUFDLElBQUksQ0FBQyxFQUFFLENBQUM7UUFDakUsTUFBTSxDQUFDLGNBQWMsR0FBRztZQUN0QixlQUFlLEVBQUUsU0FBUztZQUMxQixTQUFTLEVBQUUsU0FBUztTQUNyQixDQUFDO0tBQ0g7SUFDRCxPQUFPLE1BQU0sQ0FBQztBQUNoQixDQUFDO0FBN0JELGtEQTZCQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IHBhc2NhbENhc2UgfSBmcm9tIFwiY2hhbmdlLWNhc2VcIjtcbmltcG9ydCB7IENvbnN0cnVjdExpYnJhcnlPcHRpb25zIH0gZnJvbSBcInByb2plbi9saWIvY2RrXCI7XG5cbmV4cG9ydCB0eXBlIFJlZ2lzdHJ5ID0gXCJucG1cIiB8IFwibWF2ZW5cIiB8IFwibnVnZXRcIiB8IFwicHlwaVwiO1xuXG5leHBvcnQgdHlwZSBQdWJsaXNoT3B0aW9ucyA9IHtcbiAgbmFtZTogc3RyaW5nO1xuICBuYW1lc3BhY2U6IHN0cmluZztcbiAgcmVnaXN0cmllczogUmVnaXN0cnlbXTtcbn07XG50eXBlIE11dGFibGU8VD4gPSB7XG4gIC1yZWFkb25seSBbayBpbiBrZXlvZiBUXTogVFtrXTtcbn07XG5cbnR5cGUgQ29uZmlnID0gTXV0YWJsZTxcbiAgUGljazxcbiAgICBDb25zdHJ1Y3RMaWJyYXJ5T3B0aW9ucyxcbiAgICBcInB1Ymxpc2hUb1B5cGlcIiB8IFwicHVibGlzaFRvTWF2ZW5cIiB8IFwicHVibGlzaFRvTnVnZXRcIiB8IFwicmVsZWFzZVRvTnBtXCJcbiAgPlxuPjtcblxuZXhwb3J0IGZ1bmN0aW9uIHB1Ymxpc2hUb1JlZ2lzdHJpZXMob3B0aW9uczogUHVibGlzaE9wdGlvbnMpOiBDb25maWcge1xuICBjb25zdCB7IG5hbWUsIG5hbWVzcGFjZSwgcmVnaXN0cmllcyB9ID0gb3B0aW9ucztcbiAgY29uc3Qgc2FuaXRpemVkTmFtZXNwYWNlID0gbmFtZXNwYWNlLnJlcGxhY2UoLy0vZ2ksIFwiX1wiKTtcbiAgY29uc3Qgc2FuaXRpemVkTmFtZSA9IG5hbWUucmVwbGFjZSgvLS9naSwgXCJfXCIpO1xuICBjb25zdCBjb25maWc6IENvbmZpZyA9IHtcbiAgICByZWxlYXNlVG9OcG06IHJlZ2lzdHJpZXMuaW5jbHVkZXMoXCJucG1cIiksXG4gIH07XG5cbiAgaWYgKHJlZ2lzdHJpZXMuaW5jbHVkZXMoXCJweXBpXCIpKSB7XG4gICAgY29uZmlnLnB1Ymxpc2hUb1B5cGkgPSB7XG4gICAgICBkaXN0TmFtZTogYCR7c2FuaXRpemVkTmFtZXNwYWNlfS0ke3Nhbml0aXplZE5hbWV9YCxcbiAgICAgIG1vZHVsZTogYCR7c2FuaXRpemVkTmFtZXNwYWNlfV8ke3Nhbml0aXplZE5hbWV9YCxcbiAgICB9O1xuICB9XG4gIGlmIChyZWdpc3RyaWVzLmluY2x1ZGVzKFwibWF2ZW5cIikpIHtcbiAgICBjb25maWcucHVibGlzaFRvTWF2ZW4gPSB7XG4gICAgICBqYXZhUGFja2FnZTogYGNvbS4ke3Nhbml0aXplZE5hbWVzcGFjZX0uJHtzYW5pdGl6ZWROYW1lfWAsXG4gICAgICBtYXZlbkdyb3VwSWQ6IGBjb20uJHtzYW5pdGl6ZWROYW1lc3BhY2V9YCxcbiAgICAgIG1hdmVuQXJ0aWZhY3RJZDogc2FuaXRpemVkTmFtZSxcbiAgICB9O1xuICB9XG4gIGlmIChyZWdpc3RyaWVzLmluY2x1ZGVzKFwibnVnZXRcIikpIHtcbiAgICBjb25zdCBudWdldE5hbWUgPSBgJHtwYXNjYWxDYXNlKG5hbWVzcGFjZSl9LiR7cGFzY2FsQ2FzZShuYW1lKX1gO1xuICAgIGNvbmZpZy5wdWJsaXNoVG9OdWdldCA9IHtcbiAgICAgIGRvdE5ldE5hbWVzcGFjZTogbnVnZXROYW1lLFxuICAgICAgcGFja2FnZUlkOiBudWdldE5hbWUsXG4gICAgfTtcbiAgfVxuICByZXR1cm4gY29uZmlnO1xufVxuIl19

package/package.json

@@ -53,13 +53,15 @@
     "typescript": "^4.6.4"
   },
   "dependencies": {
+    "@types/change-case": "^2.3.1",
     "@types/uuid": "^8.3.4",
+    "change-case": "^4.1.2",
     "projen": "^0.53.6",
     "uuid": "^8.3.2"
   },
   "main": "lib/index.js",
   "license": "MIT",
-  "version": "0.1.49",
+  "version": "0.1.52",
   "jest": {
     "testMatch": [
       "<rootDir>/src/**/__tests__/**/*.ts?(x)",