projen / projen-github-action-typescript

Github Action Typescript Project

Welcome to the home of projen-github-action-typescript!

This is an external projen project type that aims to make creating GitHub Actions in TypeScript easier.

Usage

npx projen new --from projen-github-action-typescript

Features

• projen-managed action.yml file: write your yaml metadata in .projenrc.js, where your code is type-checked and available properties are easy to find.

  const project = new GitHubActionTypeScriptProject({
    name: 'my-project',
    defaultReleaseBranch: 'main',
    actionMetadata: {
      runs: {
        using: RunsUsing.NODE_12,
        main: 'dist/index.js',
      },
      inputs: {
        myInput: {
          description: 'my first input',
        },
      },
      outputs: {
        myOutput: {
          description: 'my first output',
        },
      },
    },
  });

• sensible defaults to JavaScript actions: JavaScript actions come pre-configured with the necessary workflow to bundle your source code into one index.js file that GitHub Actions can execute.

Future Features

• generate an entrypoint file that receives inputs specified in action.yml.
• generate a CLI from action.yml inputs to unlock sensible testing of the action.

Contributing

See CONTRIBUTING for more information.

License

This project is licensed under the Apache-2.0 License.

projen-github-action-typescript's Issues

Warning: New versions aren't automatically published to the Marketplace

Investigating hashicorp/terraform-cdk-action#42 sent me down a rabbit hole to investigate why our Marketplace page had never been updated even though we've done semi-regular GitHub releases. After doing a ton of digging, as far as I can tell, there's no way currently to automate publishing new versions to the Marketplace; a human has to manually go into the GitHub release, click "Edit", make sure the "Publish to Marketplace" box is checked, and save the changes -- only then does the new version show up on the Marketplace. There are no GH API or CLI options corresponding to this checkbox; hence the reason why it can't be automated.

As such, I don't think there's anything that can really be done in this repo, but at the very least I'd recommend putting a warning or something to this effect in the README, since it's not obvious and lots of folks might miss it.

`entrypoint` is silently ignored with `GitHubActionTypeScriptProject`

It isn't possible to use a name other than lib/index.js for the entrypoint configuration because the main field is set after the super() call in GitHubActionTypeScriptProject.

projen-github-action-typescript/src/project.ts

Line 33 in 8fa82a1

this.package.addField('main', 'lib/index.js');

Rather than silently ignoring a provided entrypoint, it would be helpful for the project to either throw an error (if lib/index.js is the only acceptable value) or to use options.entrypoint ?? "lib/index.js" (which should be the default anyway https://github.com/projen/projen-github-action-typescript/blob/main/API.md#entrypointoptional--1).