{"id":19177753,"url":"https://github.com/jessety/boilerplate-typescript-package","last_synced_at":"2025-04-09T21:50:50.711Z","repository":{"id":77098497,"uuid":"306663644","full_name":"jessety/boilerplate-typescript-package","owner":"jessety","description":"Boilerplate for a TypeScript package, with CI/CD for npm \u0026 gpr","archived":false,"fork":false,"pushed_at":"2021-11-01T02:29:20.000Z","size":178,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-09T21:50:46.186Z","etag":null,"topics":["boilerplate","boilerplate-typescript","ci","editorconfig","eslint","github-actions","github-package-registry","github-releases","npm-package","template","typescipt-templates","typescript","typescript-library","typescript-template"],"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/jessety.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":"2020-10-23T14:38:48.000Z","updated_at":"2025-02-24T07:00:17.000Z","dependencies_parsed_at":null,"dependency_job_id":"5b641f9d-dde1-4118-97fd-48badb0d9f5a","html_url":"https://github.com/jessety/boilerplate-typescript-package","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jessety%2Fboilerplate-typescript-package","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jessety%2Fboilerplate-typescript-package/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jessety%2Fboilerplate-typescript-package/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jessety%2Fboilerplate-typescript-package/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jessety","download_url":"https://codeload.github.com/jessety/boilerplate-typescript-package/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248119403,"owners_count":21050754,"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":["boilerplate","boilerplate-typescript","ci","editorconfig","eslint","github-actions","github-package-registry","github-releases","npm-package","template","typescipt-templates","typescript","typescript-library","typescript-template"],"created_at":"2024-11-09T10:34:57.836Z","updated_at":"2025-04-09T21:50:50.692Z","avatar_url":"https://github.com/jessety.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# boilerplate-typescript-package\n\nBoilerplate for a TypeScript npm package\n\n[![ci](https://github.com/jessety/boilerplate-typescript-package/workflows/ci/badge.svg)](https://github.com/jessety/boilerplate-typescript-package/actions/workflows/ci.yml)\n\n## Includes\n\n- TypeScript configuration\n- `ts-jest` setup for automated testing\n- ESLint rules \u0026 `editorconfig` for linting\n- Prettier and ESLint for deterministic code formatting\n- CI - build, lint \u0026 test\n- CD - automated publishing to both [npm](https://www.npmjs.com/) and the [GitHub Package Registry](https://github.com/features/packages)\n- GitHub Releases generated with automatic changelogs populated via a configurable template\n- Dependabot configuration\n- VSCode settings\n\n## Release / Publish\n\nPublishing is handled by a continuous delivery workflow within GitHub Actions. By default, new versions are dual-published to both `npm` and `gpr` (the GitHub Package Registry.) Comment one out in `.github/workflows/publish.yml` to only use one. If you would like to publish to `npm`, create a `NPM_TOKEN` repository secret. Publishing to `gpr` does not require an auth token.\n\nFirst, determine what kind of [semantic versioning](https://semver.org) bump this release will require. Updates should fall into one of three categories: `major` (new functionality with breaking changes) `minor` (new functionality without breaking changes) or `patch` (backwards compatible bug fixes).\n\nTo publish a new release, checkout the make sure your git repository is clean and run one of the following commands:\n\n- `npm run release:major` (new functionality with breaking changes)\n- `npm run release:minor` (new functionality without breaking changes)\n- `npm run release:patch` (backwards compatible bug fixes)\n\nRunning any one of these will:\n\n1. Increment the version number in `package.json`\n2. Create a git tag with the new version number\n3. Push these changes to GitHub, which triggers the `release` workflow in GitHub Actions\n4. The `release` workflow then creates a new GitHub release with changelog automatically populated with all PRs and commits since the last version\n5. The `publish` workflow is then triggered when the `release` workflow completes. It compiles the package and pushes it up to `npm` / `gpr`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjessety%2Fboilerplate-typescript-package","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjessety%2Fboilerplate-typescript-package","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjessety%2Fboilerplate-typescript-package/lists"}