@hallcor/pulumi-projen-project-types 0.0.20 → 0.0.22

package/.jsii

@@ -93,7 +93,7 @@
   },
   "name": "@hallcor/pulumi-projen-project-types",
   "readme": {
-    "markdown": "# replace this"
+    "markdown": "# Pulumi Projen Project Types\n\nCollection of [Projen](https://github.com/projen/projen) project types for use\nwith [Pulumi](https://www.pulumi.com/)\n\n## Getting Started\n\n_projen_ doesn't need to be installed. You will be using\n[npx](https://docs.npmjs.com/cli/v7/commands/npx) to run _projen_ which takes\ncare of all required setup steps.\n\nTo create a new project, run the following command and follow the instructions:\n\n```console\n$ mkdir my-project\n$ cd my-project\n$ npx projen new --from @hallcor/pulumi-projen-project-types PROJECT-TYPE\n🤖 Synthesizing project...\n...\n```\n\nOnce your project is created, you can configure your project by editing\n`.projenrc.ts` or `.projenrc.py` and re-running `npx projen` to synthesize again.\n\n> The files generated by _projen_ are considered an \"implementation detail\" and\n> _projen_ protects them from being manually edited (most files are marked\n> read-only, and an \"anti tamper\" check is configured in the CI build workflow\n> to ensure that files are not updated during build).\n\n## Projen commands\n\nFor the TypeScript based projects the project commands can be viewed an run\nusing the package manager (e.g. `yarn build`, `yarn package`, etc). For\nnon-TypeScript based projects (i.e. Python) you can use projen to view and run\nproject commands.\n\nProjen is built around a standard build process for all projects. Each project\nwill have these standard [tasks](https://projen.io/docs/concepts/tasks).\n\n1. `default`: The \"default\" task that executes projen and synthesizes the project\n2. `pre-compile`: Task that runs prior to `compile`\n3. `compile`: Compiles the project (e.g. `tsc --build` for TypeScript projects)\n4. `post-compile`: Task that runs after `compile`\n5. `test`: Task that runs the project tests\n6. `package`: Task that runs steps to package the project for publishing\n\nThere is also a standard `build` task the chains the above 6 tasks in order.\n\nThere is a great [tasks guide] where you can find more information on adding new\ntasks, editing existing tasks, etc.\n\n**List available commands**\n\n```console\n$ npx projen --help\nprojen [command]\n\nCommands:\n  projen new [PROJECT-TYPE-NAME] [OPTIONS]  Creates a new projen project\n\n                                            For a complete list of the available options for a specific project type, run:\n                                            projen new [PROJECT-TYPE-NAME] --help\n  projen build                              Full release build\n  projen bump                               Bumps version based on latest git tag and generates a changelog entry\n  projen clobber                            hard resets to HEAD of origin and cleans the local repo\n  projen compile                            Only compile\n  projen default                            Synthesize project files\n  projen dist\n  projen eject                              Remove projen from the project\n  projen install                            Install and upgrade dependencies\n  projen package                            Creates the distribution package\n  projen post-compile                       Runs after successful compilation\n  projen pre-compile                        Prepare the project for compilation\n  projen publish:git                        Prepends the release changelog onto the project changelog, creates a release commit, and tags the release\n  projen release                            Prepare a release from \"main\" branch\n  projen test                               Run tests\n  projen unbump                             Restores version to 0.0.0\n  projen completion                         generate completion script\n\nOptions:\n      --post     Run post-synthesis steps such as installing dependencies. Use --no-post to skip                                                                                                                                     [boolean] [default: true]\n  -w, --watch    Keep running and resynthesize when projenrc changes                                                                                                                                                                [boolean] [default: false]\n      --debug    Debug logs                                                                                                                                                                                                         [boolean] [default: false]\n      --rc       path to .projenrc.js file                                                                                                                        [deprecated] [string] [default: \"/Users/chall/personal/pulumi-lambda-builders/.projenrc.js\"]\n      --help     Show help                                                                                                                                                                                                                           [boolean]\n      --version  Show version number\n\n```\n\n**Run a specific command**\n\n```console\n$ npx projen build\n```\n\n**Inspect a specific command**\n\n```console\n$ npx projen build -i\ndescription: Full release build\n- default\n  description: Synthesize project files\n  - exec: python .projenrc.py\n- pre-compile\n  description: Prepare the project for compilation\n- compile\n  description: Only compile\n- post-compile\n  description: Runs after successful compilation\n- test\n  description: Run tests\n  - exec: npm ci\n  - exec: pytest\n- package\n  description: Creates the distribution package\n  - dist\n    - exec: mkdir -p dist\n    - exec: cp version.json dist/\n    - exec: git checkout version.json\n```\n\n## Project types\n\nCurrently supported project types\n\n- `PythonComponent`: Creates a Pulumi Python Component project\n- `TypeScriptComponent`: Creates a Pulumi TypeScript Component project\n\n### Pulumi Python Component\n\n```console\n$ mkdir my-python-component\n$ cd my-python-component\n$ npx projen new --from @hallcor/pulumi-projen-project-types python_component\n```\n\n\n#### Example\n\n```python\nfrom hallcor.pulumi_projen_project_types import PythonComponent\n\nproject = PythonComponent(\n    author_email=\"43035978+corymhall@users.noreply.github.com\",\n    author_name=\"corymhall\",\n    module_name=\"pulumi_lambda_builders\",\n    component_name=\"lambda-builders\",\n    name=\"pulumi-lambda-builders\",\n    version=\"0.1.0\",\n    deps=[\n        \"aws_lambda_builders\",\n    ],\n    dev_deps=[\n        \"pyfakefs\",\n        \"numpy\",\n        \"hallcor.pulumi-projen-project-types\",\n    ],\n)\n\nproject.synth()\n```\n\n#### Configuration Options\n\n- [componentName](https://github.com/corymhall/pulumi-projen-project-types/blob/main/API.md#componentnameoptional-)\nBy default the `name` of the of the Pulumi component will be taken from the\nproject `name`. This can be overridden by using the `componentName` property.\n\nFor a full list of input properties supported see the [Input Property Reference](https://github.com/corymhall/pulumi-projen-project-types/blob/main/API.md#typescriptprojectprops-)\n\n- [pulumi_python_options](https://github.com/corymhall/pulumi-projen-project-types/blob/main/API.md#pulumipythonoptionsoptional-)\nThis can be used to override some of the default Pulumi options. For example you\ncan specify a specific version of `pulumi` to use.\n\n```python\n\nproject = PythonComponent(\n    ...,\n    pulumi_python_options=PulumiPythonOptions(\n        pulumi_version=\">=3.153 <4.0\" # this is the default value\n    ),\n)\n```\n\nFor publishing related options see the [publishing section](#publishing)\n\n### Pulumi TypeScript Component\n\n```console\n$ mkdir my-python-component\n$ cd my-python-component\n$ npx projen new --from @hallcor/pulumi-projen-project-types type_script_component\n```\n\n#### Example\n\n- TODO\n\n#### Configuration Options\n\n- TODO\n\n## Publishing\n\nThe Pulumi Component project types also setup publishing workflows to publish\ngit tags and GitHub releases. By default these will\n\n> [!IMPORTANT]\n> The publishing workflows rely on [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version)\n> which means your commits must follow [Conventional Commits](https://conventionalcommits.org/)\n\n- Create an annotated tag on push to the `main` branch\n- Create a GitHub release for the tag when the tag is created\n\n### Release Trigger\n\nBy default the project will publish a new tag on every commit to the `main`\nbranch. This can be configured via the `releaseTrigger` option.\n\n- `scheduled`: Run the release workflow on a schedule\n- `manual`: Creates a publish task which can be run locally to publish a tag\n- `continuous`: Run the release workflow on every commit to the `main` branch\n\n**On a schedule**\n\n```ts\nnew TypeScriptComponent({\n  ...,\n  releaseTrigger: ReleaseTrigger.scheduled({ schedule: '0 0 * * 2' }), // run every tuesday\n});\n```\n\n**Manual**\n\n```ts\nnew TypeScriptComponent({\n  ...,\n  releaseTrigger: ReleaseTrigger.manual(),\n});\n```\n\n### GitHub Credentials\n\nFor the release workflow to create tags, specific credentials are needed.\nBy default it expects a GitHub secret variable named `PROJEN_GITHUB_TOKEN` with\n`read/write` access to `contents`. A separate token from the builtin `${{ secrets.GITHUB_TOKEN }}`\nis needed in order to trigger the downstream `release-github` workflow.\n\nThis can be customized using the `projenCredentials` option.\n\n**From a different secret**\n\n```ts\nnew TypeScriptComponent({\n  ...,\n  projenCredentials: GithubCredentials.fromPersonalAccessToken({ secret: 'MY_GITHUB_TOKEN' }),\n});\n```\n\n**From a GitHub app**\n```ts\nnew TypeScriptComponent({\n  ...,\n  projenCredentials: GithubCredentials.fromApp({\n    privateKeySecret: 'MY_GITHUB_APP_PRIVATE_KEY',\n    appIdSecret: 'MY_GITHUB_APP_ID',\n  }),\n});\n```\n\n"
   },
   "repository": {
     "type": "git",
@@ -1341,14 +1341,14 @@
         {
           "abstract": true,
           "docs": {
-            "default": "the `moduleName`",
+            "default": "the project `name`",
             "stability": "stable",
             "summary": "The name of the pulumi component."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/PythonComponentOptions.ts",
-            "line": 366
+            "line": 359
           },
           "name": "componentName",
           "optional": true,
@@ -1466,24 +1466,6 @@
             "fqn": "projen.github.GitHubOptions"
           }
         },
-        {
-          "abstract": true,
-          "docs": {
-            "default": "${{ secrets.GITHUB_TOKEN }}",
-            "stability": "stable",
-            "summary": "The GitHub Token to use when pushing the tag commit Note: if you use the default `${{ secrets.GITHUB_TOKEN }}` then the Push/Tag will not trigger any other workflows."
-          },
-          "immutable": true,
-          "locationInModule": {
-            "filename": "src/PythonComponentOptions.ts",
-            "line": 353
-          },
-          "name": "githubReleaseToken",
-          "optional": true,
-          "type": {
-            "primitive": "string"
-          }
-        },
         {
           "abstract": true,
           "docs": {
@@ -1494,7 +1476,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/PythonComponentOptions.ts",
-            "line": 360
+            "line": 353
           },
           "name": "gitIdentity",
           "optional": true,
@@ -1928,7 +1910,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/PythonComponentOptions.ts",
-            "line": 361
+            "line": 354
           },
           "name": "pulumiPythonOptions",
           "optional": true,
@@ -2021,7 +2003,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/PythonComponentOptions.ts",
-            "line": 372
+            "line": 365
           },
           "name": "releaseTrigger",
           "optional": true,
@@ -2196,7 +2178,7 @@
         },
         "locationInModule": {
           "filename": "src/release.ts",
-          "line": 10
+          "line": 12
         },
         "parameters": [
           {
@@ -2216,7 +2198,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/release.ts",
-        "line": 9
+        "line": 11
       },
       "name": "ReleaseWorkflow",
       "symbolId": "src/release:ReleaseWorkflow"
@@ -2234,7 +2216,7 @@
         },
         "locationInModule": {
           "filename": "src/release.ts",
-          "line": 74
+          "line": 76
         },
         "parameters": [
           {
@@ -2254,7 +2236,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/release.ts",
-        "line": 71
+        "line": 73
       },
       "name": "TagRelease",
       "properties": [
@@ -2265,7 +2247,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release.ts",
-            "line": 73
+            "line": 75
           },
           "name": "publishTask",
           "type": {
@@ -2279,7 +2261,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release.ts",
-            "line": 72
+            "line": 74
           },
           "name": "trigger",
           "type": {
@@ -2408,24 +2390,6 @@
             "primitive": "boolean"
           }
         },
-        {
-          "abstract": true,
-          "docs": {
-            "default": "${{ secrets.GITHUB_TOKEN }}",
-            "stability": "stable",
-            "summary": "The GitHub Token to use when pushing the tag commit Note: if you use the default `${{ secrets.GITHUB_TOKEN }}` then the Push/Tag will not trigger any other workflows."
-          },
-          "immutable": true,
-          "locationInModule": {
-            "filename": "src/TagReleaseOptions.ts",
-            "line": 251
-          },
-          "name": "githubReleaseToken",
-          "optional": true,
-          "type": {
-            "primitive": "string"
-          }
-        },
         {
           "abstract": true,
           "docs": {
@@ -2436,7 +2400,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/TagReleaseOptions.ts",
-            "line": 258
+            "line": 251
           },
           "name": "gitIdentity",
           "optional": true,
@@ -3511,7 +3475,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/typescript-options/component-options.ts",
-            "line": 914
+            "line": 907
           },
           "name": "componentName",
           "optional": true,
@@ -3884,24 +3848,6 @@
             "fqn": "projen.github.GitHubOptions"
           }
         },
-        {
-          "abstract": true,
-          "docs": {
-            "default": "${{ secrets.GITHUB_TOKEN }}",
-            "stability": "stable",
-            "summary": "The GitHub Token to use when pushing the tag commit Note: if you use the default `${{ secrets.GITHUB_TOKEN }}` then the Push/Tag will not trigger any other workflows."
-          },
-          "immutable": true,
-          "locationInModule": {
-            "filename": "src/typescript-options/component-options.ts",
-            "line": 902
-          },
-          "name": "githubReleaseToken",
-          "optional": true,
-          "type": {
-            "primitive": "string"
-          }
-        },
         {
           "abstract": true,
           "docs": {
@@ -3912,7 +3858,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/typescript-options/component-options.ts",
-            "line": 909
+            "line": 902
           },
           "name": "gitIdentity",
           "optional": true,
@@ -8081,6 +8027,6 @@
       "symbolId": "src/typescript-options/project-props:TypeScriptProjectProps"
     }
   },
-  "version": "0.0.20",
-  "fingerprint": "5Ggp/T6jAASy6F2TsYFP38JNQssvi+Izl/8v4Tmesxc="
+  "version": "0.0.22",
+  "fingerprint": "EWciccWo8h1J9jXQcvUn0FIVvdNZmW1doCQ51xEHUnY="
 }

package/API.md

@@ -5169,7 +5169,6 @@ const pythonComponentOptions: PythonComponentOptions = { ... }
 | <code><a href="#@hallcor/pulumi-projen-project-types.PythonComponentOptions.property.devContainer">devContainer</a></code> | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces). |
 | <code><a href="#@hallcor/pulumi-projen-project-types.PythonComponentOptions.property.devDeps">devDeps</a></code> | <code>string[]</code> | List of dev dependencies for this project. Dependencies use the format: `<module>@<semver>`. |
 | <code><a href="#@hallcor/pulumi-projen-project-types.PythonComponentOptions.property.githubOptions">githubOptions</a></code> | <code>projen.github.GitHubOptions</code> | Options for GitHub integration. |
-| <code><a href="#@hallcor/pulumi-projen-project-types.PythonComponentOptions.property.githubReleaseToken">githubReleaseToken</a></code> | <code>string</code> | The GitHub Token to use when pushing the tag commit Note: if you use the default `${{ secrets.GITHUB_TOKEN }}` then the Push/Tag will not trigger any other workflows. |
 | <code><a href="#@hallcor/pulumi-projen-project-types.PythonComponentOptions.property.gitIdentity">gitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use when pushing the release commit and tag Note: if you use the default github-actions user then the Push/Tag will not trigger any other workflows. |
 | <code><a href="#@hallcor/pulumi-projen-project-types.PythonComponentOptions.property.gitIgnoreOptions">gitIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .gitignore file. |
 | <code><a href="#@hallcor/pulumi-projen-project-types.PythonComponentOptions.property.gitOptions">gitOptions</a></code> | <code>projen.GitOptions</code> | Configuration options for git. |
@@ -5368,7 +5367,7 @@ public readonly componentName: string;
 ```
 
 - *Type:* string
-- *Default:* the `moduleName`
+- *Default:* the project `name`
 
 The name of the pulumi component.
 
@@ -5442,19 +5441,6 @@ Options for GitHub integration.
 
 ---
 
-##### `githubReleaseToken`<sup>Optional</sup> <a name="githubReleaseToken" id="@hallcor/pulumi-projen-project-types.PythonComponentOptions.property.githubReleaseToken"></a>
-
-```typescript
-public readonly githubReleaseToken: string;
-```
-
-- *Type:* string
-- *Default:* ${{ secrets.GITHUB_TOKEN }}
-
-The GitHub Token to use when pushing the tag commit Note: if you use the default `${{ secrets.GITHUB_TOKEN }}` then the Push/Tag will not trigger any other workflows.
-
----
-
 ##### `gitIdentity`<sup>Optional</sup> <a name="gitIdentity" id="@hallcor/pulumi-projen-project-types.PythonComponentOptions.property.gitIdentity"></a>
 
 ```typescript
@@ -5996,7 +5982,6 @@ const tagReleaseOptions: TagReleaseOptions = { ... }
 | <code><a href="#@hallcor/pulumi-projen-project-types.TagReleaseOptions.property.versionFile">versionFile</a></code> | <code>string</code> | A name of a .json file to set the `version` field in after a bump. |
 | <code><a href="#@hallcor/pulumi-projen-project-types.TagReleaseOptions.property.bumpPackage">bumpPackage</a></code> | <code>string</code> | The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string. |
 | <code><a href="#@hallcor/pulumi-projen-project-types.TagReleaseOptions.property.githubRelease">githubRelease</a></code> | <code>boolean</code> | Create a GitHub release for each release. |
-| <code><a href="#@hallcor/pulumi-projen-project-types.TagReleaseOptions.property.githubReleaseToken">githubReleaseToken</a></code> | <code>string</code> | The GitHub Token to use when pushing the tag commit Note: if you use the default `${{ secrets.GITHUB_TOKEN }}` then the Push/Tag will not trigger any other workflows. |
 | <code><a href="#@hallcor/pulumi-projen-project-types.TagReleaseOptions.property.gitIdentity">gitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use when pushing the release commit and tag Note: if you use the default github-actions user then the Push/Tag will not trigger any other workflows. |
 | <code><a href="#@hallcor/pulumi-projen-project-types.TagReleaseOptions.property.jsiiReleaseVersion">jsiiReleaseVersion</a></code> | <code>string</code> | Version requirement of `publib` which is used to publish modules to npm. |
 | <code><a href="#@hallcor/pulumi-projen-project-types.TagReleaseOptions.property.majorVersion">majorVersion</a></code> | <code>number</code> | Major version to release from the default branch. |
@@ -6112,19 +6097,6 @@ Create a GitHub release for each release.
 
 ---
 
-##### `githubReleaseToken`<sup>Optional</sup> <a name="githubReleaseToken" id="@hallcor/pulumi-projen-project-types.TagReleaseOptions.property.githubReleaseToken"></a>
-
-```typescript
-public readonly githubReleaseToken: string;
-```
-
-- *Type:* string
-- *Default:* ${{ secrets.GITHUB_TOKEN }}
-
-The GitHub Token to use when pushing the tag commit Note: if you use the default `${{ secrets.GITHUB_TOKEN }}` then the Push/Tag will not trigger any other workflows.
-
----
-
 ##### `gitIdentity`<sup>Optional</sup> <a name="gitIdentity" id="@hallcor/pulumi-projen-project-types.TagReleaseOptions.property.gitIdentity"></a>
 
 ```typescript
@@ -6581,7 +6553,6 @@ const typeScriptComponentOptions: TypeScriptComponentOptions = { ... }
 | <code><a href="#@hallcor/pulumi-projen-project-types.TypeScriptComponentOptions.property.eslint">eslint</a></code> | <code>boolean</code> | Setup eslint. |
 | <code><a href="#@hallcor/pulumi-projen-project-types.TypeScriptComponentOptions.property.eslintOptions">eslintOptions</a></code> | <code><a href="#@hallcor/pulumi-projen-project-types.EslintOptions">EslintOptions</a></code> | Eslint options. |
 | <code><a href="#@hallcor/pulumi-projen-project-types.TypeScriptComponentOptions.property.githubOptions">githubOptions</a></code> | <code>projen.github.GitHubOptions</code> | Options for GitHub integration. |
-| <code><a href="#@hallcor/pulumi-projen-project-types.TypeScriptComponentOptions.property.githubReleaseToken">githubReleaseToken</a></code> | <code>string</code> | The GitHub Token to use when pushing the tag commit Note: if you use the default `${{ secrets.GITHUB_TOKEN }}` then the Push/Tag will not trigger any other workflows. |
 | <code><a href="#@hallcor/pulumi-projen-project-types.TypeScriptComponentOptions.property.gitIdentity">gitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use when pushing the release commit and tag Note: if you use the default github-actions user then the Push/Tag will not trigger any other workflows. |
 | <code><a href="#@hallcor/pulumi-projen-project-types.TypeScriptComponentOptions.property.gitignore">gitignore</a></code> | <code>string[]</code> | Additional entries to .gitignore. |
 | <code><a href="#@hallcor/pulumi-projen-project-types.TypeScriptComponentOptions.property.gitIgnoreOptions">gitIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .gitignore file. |
@@ -7338,19 +7309,6 @@ Options for GitHub integration.
 
 ---
 
-##### `githubReleaseToken`<sup>Optional</sup> <a name="githubReleaseToken" id="@hallcor/pulumi-projen-project-types.TypeScriptComponentOptions.property.githubReleaseToken"></a>
-
-```typescript
-public readonly githubReleaseToken: string;
-```
-
-- *Type:* string
-- *Default:* ${{ secrets.GITHUB_TOKEN }}
-
-The GitHub Token to use when pushing the tag commit Note: if you use the default `${{ secrets.GITHUB_TOKEN }}` then the Push/Tag will not trigger any other workflows.
-
----
-
 ##### `gitIdentity`<sup>Optional</sup> <a name="gitIdentity" id="@hallcor/pulumi-projen-project-types.TypeScriptComponentOptions.property.gitIdentity"></a>
 
 ```typescript

package/README.md

@@ -1 +1,270 @@
-# replace this
+# Pulumi Projen Project Types
+
+Collection of [Projen](https://github.com/projen/projen) project types for use
+with [Pulumi](https://www.pulumi.com/)
+
+## Getting Started
+
+_projen_ doesn't need to be installed. You will be using
+[npx](https://docs.npmjs.com/cli/v7/commands/npx) to run _projen_ which takes
+care of all required setup steps.
+
+To create a new project, run the following command and follow the instructions:
+
+```console
+$ mkdir my-project
+$ cd my-project
+$ npx projen new --from @hallcor/pulumi-projen-project-types PROJECT-TYPE
+🤖 Synthesizing project...
+...
+```
+
+Once your project is created, you can configure your project by editing
+`.projenrc.ts` or `.projenrc.py` and re-running `npx projen` to synthesize again.
+
+> The files generated by _projen_ are considered an "implementation detail" and
+> _projen_ protects them from being manually edited (most files are marked
+> read-only, and an "anti tamper" check is configured in the CI build workflow
+> to ensure that files are not updated during build).
+
+## Projen commands
+
+For the TypeScript based projects the project commands can be viewed an run
+using the package manager (e.g. `yarn build`, `yarn package`, etc). For
+non-TypeScript based projects (i.e. Python) you can use projen to view and run
+project commands.
+
+Projen is built around a standard build process for all projects. Each project
+will have these standard [tasks](https://projen.io/docs/concepts/tasks).
+
+1. `default`: The "default" task that executes projen and synthesizes the project
+2. `pre-compile`: Task that runs prior to `compile`
+3. `compile`: Compiles the project (e.g. `tsc --build` for TypeScript projects)
+4. `post-compile`: Task that runs after `compile`
+5. `test`: Task that runs the project tests
+6. `package`: Task that runs steps to package the project for publishing
+
+There is also a standard `build` task the chains the above 6 tasks in order.
+
+There is a great [tasks guide] where you can find more information on adding new
+tasks, editing existing tasks, etc.
+
+**List available commands**
+
+```console
+$ npx projen --help
+projen [command]
+
+Commands:
+  projen new [PROJECT-TYPE-NAME] [OPTIONS]  Creates a new projen project
+
+                                            For a complete list of the available options for a specific project type, run:
+                                            projen new [PROJECT-TYPE-NAME] --help
+  projen build                              Full release build
+  projen bump                               Bumps version based on latest git tag and generates a changelog entry
+  projen clobber                            hard resets to HEAD of origin and cleans the local repo
+  projen compile                            Only compile
+  projen default                            Synthesize project files
+  projen dist
+  projen eject                              Remove projen from the project
+  projen install                            Install and upgrade dependencies
+  projen package                            Creates the distribution package
+  projen post-compile                       Runs after successful compilation
+  projen pre-compile                        Prepare the project for compilation
+  projen publish:git                        Prepends the release changelog onto the project changelog, creates a release commit, and tags the release
+  projen release                            Prepare a release from "main" branch
+  projen test                               Run tests
+  projen unbump                             Restores version to 0.0.0
+  projen completion                         generate completion script
+
+Options:
+      --post     Run post-synthesis steps such as installing dependencies. Use --no-post to skip                                                                                                                                     [boolean] [default: true]
+  -w, --watch    Keep running and resynthesize when projenrc changes                                                                                                                                                                [boolean] [default: false]
+      --debug    Debug logs                                                                                                                                                                                                         [boolean] [default: false]
+      --rc       path to .projenrc.js file                                                                                                                        [deprecated] [string] [default: "/Users/chall/personal/pulumi-lambda-builders/.projenrc.js"]
+      --help     Show help                                                                                                                                                                                                                           [boolean]
+      --version  Show version number              
+
+```
+
+**Run a specific command**
+
+```console
+$ npx projen build
+```
+
+**Inspect a specific command**
+
+```console
+$ npx projen build -i
+description: Full release build
+- default
+  description: Synthesize project files
+  - exec: python .projenrc.py
+- pre-compile
+  description: Prepare the project for compilation
+- compile
+  description: Only compile
+- post-compile
+  description: Runs after successful compilation
+- test
+  description: Run tests
+  - exec: npm ci
+  - exec: pytest
+- package
+  description: Creates the distribution package
+  - dist
+    - exec: mkdir -p dist
+    - exec: cp version.json dist/
+    - exec: git checkout version.json
+```
+
+## Project types
+
+Currently supported project types
+
+- `PythonComponent`: Creates a Pulumi Python Component project
+- `TypeScriptComponent`: Creates a Pulumi TypeScript Component project
+
+### Pulumi Python Component
+
+```console
+$ mkdir my-python-component
+$ cd my-python-component
+$ npx projen new --from @hallcor/pulumi-projen-project-types python_component
+```
+
+
+#### Example
+
+```python
+from hallcor.pulumi_projen_project_types import PythonComponent
+
+project = PythonComponent(
+    author_email="43035978+corymhall@users.noreply.github.com",
+    author_name="corymhall",
+    module_name="pulumi_lambda_builders",
+    component_name="lambda-builders",
+    name="pulumi-lambda-builders",
+    version="0.1.0",
+    deps=[
+        "aws_lambda_builders",
+    ],
+    dev_deps=[
+        "pyfakefs",
+        "numpy",
+        "hallcor.pulumi-projen-project-types",
+    ],
+)
+
+project.synth()
+```
+
+#### Configuration Options
+
+- [componentName](https://github.com/corymhall/pulumi-projen-project-types/blob/main/API.md#componentnameoptional-)
+By default the `name` of the of the Pulumi component will be taken from the
+project `name`. This can be overridden by using the `componentName` property.
+
+For a full list of input properties supported see the [Input Property Reference](https://github.com/corymhall/pulumi-projen-project-types/blob/main/API.md#typescriptprojectprops-)
+
+- [pulumi_python_options](https://github.com/corymhall/pulumi-projen-project-types/blob/main/API.md#pulumipythonoptionsoptional-)
+This can be used to override some of the default Pulumi options. For example you
+can specify a specific version of `pulumi` to use.
+
+```python
+
+project = PythonComponent(
+    ...,
+    pulumi_python_options=PulumiPythonOptions(
+        pulumi_version=">=3.153 <4.0" # this is the default value
+    ),
+)
+```
+
+For publishing related options see the [publishing section](#publishing)
+
+### Pulumi TypeScript Component
+
+```console
+$ mkdir my-python-component
+$ cd my-python-component
+$ npx projen new --from @hallcor/pulumi-projen-project-types type_script_component
+```
+
+#### Example
+
+- TODO
+
+#### Configuration Options
+
+- TODO
+
+## Publishing
+
+The Pulumi Component project types also setup publishing workflows to publish
+git tags and GitHub releases. By default these will
+
+> [!IMPORTANT]  
+> The publishing workflows rely on [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version)
+> which means your commits must follow [Conventional Commits](https://conventionalcommits.org/)
+
+- Create an annotated tag on push to the `main` branch
+- Create a GitHub release for the tag when the tag is created
+
+### Release Trigger
+
+By default the project will publish a new tag on every commit to the `main`
+branch. This can be configured via the `releaseTrigger` option.
+
+- `scheduled`: Run the release workflow on a schedule
+- `manual`: Creates a publish task which can be run locally to publish a tag
+- `continuous`: Run the release workflow on every commit to the `main` branch
+
+**On a schedule**
+
+```ts
+new TypeScriptComponent({
+  ...,
+  releaseTrigger: ReleaseTrigger.scheduled({ schedule: '0 0 * * 2' }), // run every tuesday
+});
+```
+
+**Manual**
+
+```ts
+new TypeScriptComponent({
+  ...,
+  releaseTrigger: ReleaseTrigger.manual(),
+});
+```
+
+### GitHub Credentials
+
+For the release workflow to create tags, specific credentials are needed.
+By default it expects a GitHub secret variable named `PROJEN_GITHUB_TOKEN` with
+`read/write` access to `contents`. A separate token from the builtin `${{ secrets.GITHUB_TOKEN }}`
+is needed in order to trigger the downstream `release-github` workflow.
+
+This can be customized using the `projenCredentials` option.
+
+**From a different secret**
+
+```ts
+new TypeScriptComponent({
+  ...,
+  projenCredentials: GithubCredentials.fromPersonalAccessToken({ secret: 'MY_GITHUB_TOKEN' }),
+});
+```
+
+**From a GitHub app**
+```ts
+new TypeScriptComponent({
+  ...,
+  projenCredentials: GithubCredentials.fromApp({
+    privateKeySecret: 'MY_GITHUB_APP_PRIVATE_KEY',
+    appIdSecret: 'MY_GITHUB_APP_ID',
+  }),
+});
+```
+

package/lib/PythonComponentOptions.d.ts

@@ -342,13 +342,6 @@ export interface PythonComponentOptions {
      * @featured true
      */
     readonly name: string;
-    /**
-     * The GitHub Token to use when pushing the tag commit
-     * Note: if you use the default `${{ secrets.GITHUB_TOKEN }}` then the
-     * Push/Tag will not trigger any other workflows
-     * @default ${{ secrets.GITHUB_TOKEN }}
-     */
-    readonly githubReleaseToken?: string;
     /**
      * The git identity to use when pushing the release commit and tag
      * Note: if you use the default github-actions user then the
@@ -359,7 +352,7 @@ export interface PythonComponentOptions {
     readonly pulumiPythonOptions?: PulumiPythonOptions;
     /**
      * The name of the pulumi component
-     * @default the `moduleName`
+     * @default the project `name`
      */
     readonly componentName?: string;
     /**