{"id":20385121,"url":"https://github.com/poad/typescript-action-template","last_synced_at":"2026-06-07T15:32:23.320Z","repository":{"id":65269238,"uuid":"589124119","full_name":"poad/typescript-action-template","owner":"poad","description":null,"archived":false,"fork":false,"pushed_at":"2024-04-11T23:50:23.000Z","size":3270,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-04-14T10:50:15.186Z","etag":null,"topics":["github-actions"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/poad.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-01-15T06:02:58.000Z","updated_at":"2024-08-22T07:07:37.965Z","dependencies_parsed_at":"2023-12-17T20:42:58.120Z","dependency_job_id":"555665ed-b0e1-4e89-8115-690d8617e532","html_url":"https://github.com/poad/typescript-action-template","commit_stats":{"total_commits":40,"total_committers":3,"mean_commits":"13.333333333333334","dds":0.125,"last_synced_commit":"b6890f7ed1b674ef1c754f6d384c9f40252653a5"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":"actions/typescript-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/poad%2Ftypescript-action-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/poad%2Ftypescript-action-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/poad%2Ftypescript-action-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/poad%2Ftypescript-action-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/poad","download_url":"https://codeload.github.com/poad/typescript-action-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241935267,"owners_count":20044827,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-actions"],"created_at":"2024-11-15T02:32:30.318Z","updated_at":"2026-06-07T15:32:23.310Z","avatar_url":"https://github.com/poad.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/actions/typescript-action/actions\"\u003e\u003cimg alt=\"typescript-action status\" src=\"https://github.com/actions/typescript-action/workflows/build-test/badge.svg\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n# Create a JavaScript Action using TypeScript\n\nUse this template to bootstrap the creation of a TypeScript action.:rocket:\n\nThis template includes compilation support, tests, a validation workflow, publishing, and versioning guidance.  \n\nIf you are new, there's also a simpler introduction.  See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)\n\n## Create an action from this template\n\nClick the `Use this Template` and provide the new repo details for your action\n\n## Code in Main\n\n\u003e First, you'll need to have a reasonably modern version of `node` handy. This won't work with versions older than 9, for instance.\n\nInstall the dependencies  \n\n```bash\nnpm install\n```\n\nBuild the typescript and package it for distribution\n\n```bash\nnpm run build \u0026\u0026 npm run package\n```\n\nRun the tests :heavy_check_mark:  \n\n```bash\n$ npm test\n\n PASS  ./index.test.js\n  ✓ throws invalid number (3ms)\n  ✓ wait 500 ms (504ms)\n  ✓ test runs (95ms)\n\n...\n```\n\n## Change action.yml\n\nThe action.yml defines the inputs and output for your action.\n\nUpdate the action.yml with your name, description, inputs and outputs for your action.\n\nSee the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions)\n\n## Change the Code\n\nMost toolkit and CI/CD operations involve async operations so the action is run in an async function.\n\n```javascript\nimport * as core from '@actions/core';\n...\n\nasync function run() {\n  try { \n      ...\n  } \n  catch (error) {\n    core.setFailed(error.message);\n  }\n}\n\nrun()\n```\n\nSee the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages.\n\n## Publish to a distribution branch\n\nActions are run from GitHub repos so we will checkin the packed dist folder.\n\nThen run [ncc](https://github.com/zeit/ncc) and push the results:\n\n```bash\nnpm run package\ngit add dist\ngit commit -a -m \"prod dependencies\"\ngit push origin releases/v1\n```\n\nNote: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project.\n\nYour action is now published! :rocket:\n\nSee the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)\n\n## Validate\n\nYou can now validate the action by referencing `./` in a workflow in your repo (see [test.yml](.github/workflows/test.yml))\n\n```yaml\nuses: ./\nwith:\n  milliseconds: 1000\n```\n\nSee the [actions tab](https://github.com/actions/typescript-action/actions) for runs of this action! :rocket:\n\n## Usage\n\nAfter testing you can [create a v1 tag](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) to reference the stable and latest V1 action\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpoad%2Ftypescript-action-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpoad%2Ftypescript-action-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpoad%2Ftypescript-action-template/lists"}