|
1 |
| -# `gigachad.ts` |
| 1 | +# `@coderabbitai/bitbucket` |
2 | 2 |
|
3 |
| -[](https://github.com/NatoBoram/gigachad.ts/actions/workflows/docker.yaml) [](https://github.com/NatoBoram/gigachad.ts/actions/workflows/github-pages.yaml) [](https://github.com/NatoBoram/gigachad.ts/actions/workflows/node.js.yaml) [](https://github.com/NatoBoram/gigachad.ts/actions/workflows/dependabot/dependabot-updates) |
| 3 | +[](https://github.com/coderabbitai/bitbucket/actions/workflows/node.js.yaml) [](https://github.com/coderabbitai/bitbucket/actions/workflows/dependabot/dependabot-updates) [](https://github.com/coderabbitai/bitbucket/actions/workflows/github-pages.yaml) |
4 | 4 |
|
5 |
| -The most gigachad project setup for TypeScript. |
6 |
| - |
7 |
| -<img |
8 |
| - align="right" |
9 |
| - alt="The most gigachad TypeScript programmer, writing high-quality well-tested code, big muscles, enjoyer, handsome face, digital painting, high resolution, ultra realistic, hands on keyboard" |
10 |
| - src="https://github.com/NatoBoram/gigachad.ts/assets/10495562/b113f3ee-38cf-4014-9a2e-737a48bad2e0" |
11 |
| - width="256" |
12 |
| -/> |
13 |
| - |
14 |
| -- Dependency updates with [Dependabot](https://github.com/dependabot/dependabot-core) |
15 |
| -- Documentation with [TypeDoc](https://github.com/TypeStrong/typedoc) |
16 |
| -- Enforce format-on-save in [VSCode](https://github.com/microsoft/vscode) |
17 |
| -- Formatting with [Prettier](https://github.com/prettier/prettier) |
18 |
| -- Lint code with [ESLint](https://github.com/eslint/eslint) |
19 |
| -- Lint markdown with [markdownlint](https://github.com/DavidAnson/markdownlint) |
20 |
| -- Package management with [pnpm](https://github.com/pnpm/pnpm) |
21 |
| -- Publish it with a GitHub Workflow |
22 |
| -- Run it with [tsx](https://github.com/privatenumber/tsx) |
23 |
| -- Run your GitHub Actions locally with [`act`](https://github.com/nektos/act) |
24 |
| -- Unit tests with [Vitest](https://github.com/vitest-dev/vitest) |
25 |
| - |
26 |
| -## Publishing |
27 |
| - |
28 |
| -This template offers a GitHub Workflow to help you automatically bump the version number, tag it, push it, and publish it to both NPM, the GitHub Package Registry and in GitHub Releases on the click of a button. |
29 |
| - |
30 |
| -To make the `git push` work, you'll need to use a [Deploy Key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys). |
31 |
| - |
32 |
| -1. Genereate a SSH key with <https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#generating-a-new-ssh-key> |
33 |
| - |
34 |
| - ```sh |
35 |
| - ssh-keygen -t ed25519 -C "@natoboram/gigachad.ts" -f new_ssh_key -N "" |
36 |
| - ``` |
37 |
| - |
38 |
| -2. Add the private key to your project's secrets at `/settings/secrets/actions/new` with the name `DEPLOY_KEY_PRIVATE` |
39 |
| -3. Add the public key to your project's variables at `/settings/variables/actions/new` with the name `DEPLOY_KEY_PUBLIC` |
40 |
| -4. Add the public key to your project's deploy keys at `/settings/keys` |
41 |
| -5. Add the public key to `.github/authorized_keys` in the format of `41898282+github-actions[bot]@users.noreply.github.com <DEPLOY_KEY_PUBLIC>` while replacing `<DEPLOY_KEY_PUBLIC>` with your public key |
42 |
| -6. Delete the key pair from your computer, never to be seen again |
43 |
| - |
44 |
| -The `.github/authorized_keys` is used to sign and verify the signature of the build artefact that is sent to GitHub Releases. If you want to skip this step, you can remove it from `.github/workflows/pnpm-publish.yaml`. |
45 |
| - |
46 |
| -To publish on NPM, you'll need to provide your NPM token. |
47 |
| - |
48 |
| -1. Sign in to <https://www.npmjs.com> |
49 |
| -2. Access Tokens / Generate New Token / Classic Token / Automation / Generate Token |
50 |
| -3. Copy that token and save it in your project's secrets at `/settings/secrets/actions/new` with the name `NODE_AUTH_TOKEN` |
| 5 | +CodeRabbit's TypeScript API client for connecting to Bitbucket Cloud and Bitbucker Data Center. |
0 commit comments