{"id":13566591,"url":"https://github.com/NickLiffen/actions-boilerplate","last_synced_at":"2025-04-04T00:31:16.547Z","repository":{"id":39260955,"uuid":"430764710","full_name":"NickLiffen/actions-boilerplate","owner":"NickLiffen","description":"Sample Typescript Actions Template","archived":false,"fork":false,"pushed_at":"2024-07-01T10:34:13.000Z","size":466,"stargazers_count":5,"open_issues_count":4,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-07-08T11:22:32.654Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NickLiffen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2021-11-22T15:35:34.000Z","updated_at":"2023-05-26T18:44:51.000Z","dependencies_parsed_at":"2023-02-17T22:01:06.972Z","dependency_job_id":"a1bccc76-59ed-4519-88da-2d3fd5af3a28","html_url":"https://github.com/NickLiffen/actions-boilerplate","commit_stats":{"total_commits":52,"total_committers":2,"mean_commits":26.0,"dds":0.5,"last_synced_commit":"3b369a1a8f2a58d5af1bbb250af3a3fdd6b47bf0"},"previous_names":[],"tags_count":2,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NickLiffen%2Factions-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NickLiffen%2Factions-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NickLiffen%2Factions-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NickLiffen%2Factions-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NickLiffen","download_url":"https://codeload.github.com/NickLiffen/actions-boilerplate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":213527962,"owners_count":15600793,"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":[],"created_at":"2024-08-01T13:02:12.607Z","updated_at":"2024-08-01T13:17:14.728Z","avatar_url":"https://github.com/NickLiffen.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"# GitHub Actions Boilerplate\n\n## Introduction\n\nA sample GitHub action boilerplate for Typescript actions.\n\nIt comes with:\n\n- **Node 16 Support**: Current LTS.\n- **ESlint and Prettier**: Code quality and consistency tooling.\n- **Husky**: Pre-commit hook ensuring code is built before being deployed to GitHub.\n\nThere are many open source actions boilerplates/templates. I use this one as I try and keep it up to date and simplistic.\n\n## Getting Started\n\nClick [Use this template](https://github.com/NickLiffen/actions-boilerplate/generate) on this repository. Enter in your action repository name and description, and click *Create repository from template*.\n\nClose down locally, and run:\n\n```sh\nyarn install --frozen-lockfile \u0026\u0026 yarn run build\n```\n\nEdit the required fields within the `package.json` and `action.yml` and you should be good to go. Simply start writing code within the `src` directory.\n\n## Testing Locally\n\nWe use [act](https://github.com/nektos/act) to test our actions locally. If you are interested in testing your action locally, you will need to do a few things:\n\n1. Create a `my.secrets` file. This file will contain all the secrets required in your workflow to test this action.\n2. Create a `.env.` within the root of this repository. This file will contain any environment variables required in your workflow to test this action.\n3. Update the `.github/workflows/regression.yml` file to test your action. This will include updating any `events` in the workflow and inputs.\n4. Update the `.github/workflows/regression/payload.yml` file, which contains the input payload for your action.\n\nOnce you have done the above, you are ready to test locally and run `yarn run local`. This will trigger `act` to run your workflow and, therefore, your action.\n\nFor more information on how to use act, see the instructions here: [Act Overview](https://github.com/nektos/act/blob/master/README.md).\n\n## Contributing?\n\nSimply raise a pull request :) Make sure CI passes and then you should be good to go.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNickLiffen%2Factions-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FNickLiffen%2Factions-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNickLiffen%2Factions-boilerplate/lists"}