{"id":16962538,"url":"https://github.com/threeal/action-starter","last_synced_at":"2025-04-11T21:31:26.514Z","repository":{"id":197028673,"uuid":"694500793","full_name":"threeal/action-starter","owner":"threeal","description":"A minimalist template for starting a new GitHub Action project","archived":false,"fork":false,"pushed_at":"2025-04-01T15:30:10.000Z","size":2469,"stargazers_count":3,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-01T15:44:33.093Z","etag":null,"topics":["actions","github-actions","javascript","nodejs","template","template-project","templates","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/threeal.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":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-21T06:02:10.000Z","updated_at":"2025-04-01T14:46:12.000Z","dependencies_parsed_at":"2024-04-19T07:45:57.799Z","dependency_job_id":"d45e99df-5db0-49ff-a246-3e7295c091b9","html_url":"https://github.com/threeal/action-starter","commit_stats":{"total_commits":332,"total_committers":2,"mean_commits":166.0,"dds":"0.30722891566265065","last_synced_commit":"af01a5af26c4ce0c950282cd3e10533849367499"},"previous_names":["threeal/action-starter"],"tags_count":12,"template":true,"template_full_name":"threeal/nodejs-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/threeal%2Faction-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/threeal%2Faction-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/threeal%2Faction-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/threeal%2Faction-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/threeal","download_url":"https://codeload.github.com/threeal/action-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248482947,"owners_count":21111406,"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":["actions","github-actions","javascript","nodejs","template","template-project","templates","typescript"],"created_at":"2024-10-13T23:07:04.255Z","updated_at":"2025-04-11T21:31:26.504Z","avatar_url":"https://github.com/threeal.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- TODO: Replace the content of this file with the new project description. --\u003e\n\n# Action Starter\n\nA minimalist template for starting a new [GitHub Action](https://github.com/features/actions) project.\n\nThis template provides a basic GitHub Action project containing a sample [JavaScript action](https://docs.github.com/en/actions/sharing-automations/creating-actions/creating-a-javascript-action) written in [TypeScript](https://www.typescriptlang.org/), with built-in support for formatting, linting, testing, and continuous integration.\n\n## Key Features\n\n- Minimal GitHub Action project written in TypeScript with [ESM](https://nodejs.org/api/esm.html) support.\n- Uses [pnpm](https://pnpm.io//) as the package manager.\n- Supports formatting with [Prettier](https://prettier.io/), linting with [ESLint](https://eslint.org/), and testing with [Vitest](https://vitest.dev/).\n- Preconfigured workflows for [Dependabot](https://docs.github.com/en/code-security/dependabot) and [GitHub Actions](https://github.com/features/actions).\n\n## Usage\n\nThis guide explains how to use this template to start a new GitHub Action project, from creation to release.\n\n### Create a New Project\n\nFollow [this link](https://github.com/new?template_name=action-starter\u0026template_owner=threeal) to create a new project based on this template. For more information about creating a repository from a template on GitHub, refer to [this documentation](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).\n\nAlternatively, you can clone this repository locally to begin using this template.\n\n### Choose a License\n\nBy default, this template is [unlicensed](https://unlicense.org/). Before modifying this template, replace the [`LICENSE`](./LICENSE) file with the license to be used by the new project. For more information about licensing a repository, refer to [this documentation](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\n\nAlternatively, you can remove the `LICENSE` file or leave it as-is to keep the new project unlicensed.\n\n### Update Project Information\n\nTo replace the sample information in this template with details about your new project, complete the following steps:\n\n- Replace the content of this [`README.md`](./README.md) file with a description of the new project. For more information on adding READMEs to a project, refer to [this documentation](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes).\n- Modify the action metadata in the [`action.yml`](./action.yml) file according to the new project specifications. For more details on the action metadata, refer to [this documentation](https://docs.github.com/en/actions/sharing-automations/creating-actions/metadata-syntax-for-github-actions).\n\n\u003e Note: You can also search for `TODO` comments for a list of information that needs to be replaced.\n\n### Set Up Tools\n\nThis template uses [pnpm](https://pnpm.io/) as the package manager. If pnpm is not installed, follow [this guide](https://pnpm.io/installation) to install it. Then, install the project dependencies with:\n\n```sh\npnpm install\n```\n\nFor more information on pnpm, including adding dependencies or running tools, refer to [this documentation](https://pnpm.io/pnpm-cli).\n\n### Developing the Action\n\nWrite the logic for the action in the [`src/main.ts`](./src/main.ts) file according to the project requirements. If you're new to [TypeScript](https://www.typescriptlang.org/), refer to [this documentation](https://www.typescriptlang.org/docs/) for guidance.\n\nIf the action will support pre- and post-steps, additional files like `src/pre.ts` and `src/post.ts` can be added. Just make sure to update the Rollup configuration in the [`rollup.config.js`](./rollup.config.js) file and the action metadata in the [`action.yml`](./action.yml) file.\n\nOnce the code is written, format it with:\n\n```sh\npnpm format\n```\n\nThen, check linting with:\n\n```sh\npnpm lint\n```\n\nLastly, build and bundle the action files with:\n\n```sh\npnpm build\n```\n\n### Testing the Action\n\nTest files in this template are named `*.test.ts` and typically correspond to the source files being tested. This template uses [Vitest](https://vitest.dev/) as the testing framework. For more information on testing with Vitest, refer to [this documentation](https://vitest.dev/guide/).\n\nAfter creating your test files, run tests with:\n\n```sh\npnpm test\n```\n\nAdditionally, you can test the action by running it directly from the GitHub workflow as specified in the [`.github/workflows/test.yaml`](./.github/workflows/test.yaml) file.\n\n### Release the Action\n\nWhen the project is complete, release and publish it from the project repository page on GitHub. For more information on releasing a project, refer to [this documentation](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases). For more information on publishing GitHub actions, refer to [this documentation](https://docs.github.com/en/actions/sharing-automations/creating-actions/publishing-actions-in-github-marketplace).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthreeal%2Faction-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthreeal%2Faction-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthreeal%2Faction-starter/lists"}