Merge pull request #22 from MV-Consulting/feat/more-jsii-releases

feat: add releases to pypi and golang

.projenrc.ts

@@ -1,4 +1,4 @@
-import { awscdk } from 'projen';
+import { awscdk, ReleasableCommits } from 'projen';
 import { NpmAccess } from 'projen/lib/javascript';
 const project = new awscdk.AwsCdkConstructLibrary({
   author: 'Manuel Vogel',
@@ -50,6 +50,31 @@ const project = new awscdk.AwsCdkConstructLibrary({
       'integ-tests/**/*.ts',
     ],
   },
+  // see details for each: https://github.com/cdklabs/publib
+  // Go
+  publishToGo: {
+    moduleName: 'github.com/MV-Consulting/cdk-vscode-server',
+    githubTokenSecret: 'PROJEN_GITHUB_TOKEN',
+  },
+  // see https://github.com/cdklabs/publib/issues/1305
+  // Java
+  // publishToMaven: {
+  //   javaPackage: 'io.github.mv-consulting.cdk.vscode.server',
+  //   mavenGroupId: 'io.github.mv-consulting',
+  //   mavenArtifactId: 'cdkvscodeserver',
+  // },
+
+  // Note: Microsoft Account needed
+  // C# and F# for .NET
+  // publishToNuget: {
+  //   dotNetNamespace: 'MvConsulting',
+  //   packageId: 'CdkVscodeServer',
+  // },
+  // Python
+  publishToPypi: {
+    distName: 'cdk-vscode-server',
+    module: 'cdk-vscode-server',
+  },
   pullRequestTemplateContents: [`
 **Please check if the PR fulfills these requirements**
 - [ ] The commit message describes your change
@@ -74,6 +99,47 @@ const project = new awscdk.AwsCdkConstructLibrary({
 - version of the construct: \`x.x.x\`
   `],
   // NOTE: issue templates are not supported yet. See https://github.com/projen/projen/pull/3648
+  // issueTemplates: {}
+
+  // See https://github.com/projen/projen/discussions/4040#discussioncomment-11905628
+  releasableCommits: ReleasableCommits.ofType([
+    'feat',
+    'fix',
+    'chore',
+    'refactor',
+    'perf',
+  ]),
+  githubOptions: {
+    pullRequestLintOptions: {
+      semanticTitleOptions: {
+        types: [
+          // see commit types here: https://www.conventionalcommits.org/en/v1.0.0/#summary
+          'feat',
+          'fix',
+          'chore',
+          'refactor',
+          'perf',
+          'docs',
+          'style',
+          'test',
+          'build',
+          'ci',
+        ],
+      },
+    },
+  },
+  versionrcOptions: {
+    types: [
+      { type: 'feat', section: 'Features' },
+      { type: 'fix', section: 'Bug Fixes' },
+      { type: 'chore', section: 'Chores' },
+      { type: 'docs', section: 'Docs' },
+      { type: 'style', hidden: true },
+      { type: 'refactor', hidden: true },
+      { type: 'perf', section: 'Performance' },
+      { type: 'test', hidden: true },
+    ],
+  },
 });
 
 project.package.setScript('integ-test', 'integ-runner --directory ./integ-tests --parallel-regions eu-west-1 --parallel-regions eu-west-2 --update-on-failed');

CONTRIBUTING.md

@@ -34,6 +34,15 @@ To send us a pull request, please:
 3. Ensure local tests pass -> `yarn run test`
 4. The integ tests will run separately in the AWS account of the owner of the project.
 5. Build the project -> `yarn run build` to also update the `API.md` file.
+```bash
+# do this within the container as we build jsii for multiple targets
+docker run -it --rm -v $(pwd):/source -w /source --user 0:0 public.ecr.aws/jsii/superchain:1-bookworm-slim-node20 bash
+# clean node_modules for fresh dependencies for the OS within the container
+rm -rf node_modules
+yarn install
+# now build it
+yarn run build
+```
 6. Commit to your fork using clear commit messages.
 7. Send us a pull request, answering any default questions in the pull request interface.
 8. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.