generated from NatoBoram/gigachad.ts
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
19 changed files
with
717 additions
and
638 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| * @NatoBoram | ||
| *.ts @coderabbitai/typescript-reviewers |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| 41898282+github-actions[bot]@users.noreply.github.com ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIE0nNJJzdXWCLFEqZd4BMgzbTfabG3Z2kamWwXOpRqBI 41898282+github-actions[bot]@users.noreply.github.com | ||
| 41898282+github-actions[bot]@users.noreply.github.com ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJwlBXpWbU695PCyqzVdh+pmps81LzlZak63ODGmlo8P @coderabbitai/bitbucket |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1 @@ | ||
| This is free and unencumbered software released into the public domain. | ||
|
|
||
| Anyone is free to copy, modify, publish, use, compile, sell, or | ||
| distribute this software, either in source code form or as a compiled | ||
| binary, for any purpose, commercial or non-commercial, and by any | ||
| means. | ||
|
|
||
| In jurisdictions that recognize copyright laws, the author or authors | ||
| of this software dedicate any and all copyright interest in the | ||
| software to the public domain. We make this dedication for the benefit | ||
| of the public at large and to the detriment of our heirs and | ||
| successors. We intend this dedication to be an overt act of | ||
| relinquishment in perpetuity of all present and future rights to this | ||
| software under copyright law. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | ||
| EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | ||
| MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. | ||
| IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR | ||
| OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, | ||
| ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR | ||
| OTHER DEALINGS IN THE SOFTWARE. | ||
| Copyright © 2024 CodeRabbit |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,50 +1,5 @@ | ||
| # `gigachad.ts` | ||
| # `@coderabbitai/bitbucket` | ||
|
|
||
| [](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) | ||
| [](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) | ||
|
|
||
| The most gigachad project setup for TypeScript. | ||
|
|
||
| <img | ||
| align="right" | ||
| 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" | ||
| src="https://github.com/NatoBoram/gigachad.ts/assets/10495562/b113f3ee-38cf-4014-9a2e-737a48bad2e0" | ||
| width="256" | ||
| /> | ||
|
|
||
| - Dependency updates with [Dependabot](https://github.com/dependabot/dependabot-core) | ||
| - Documentation with [TypeDoc](https://github.com/TypeStrong/typedoc) | ||
| - Enforce format-on-save in [VSCode](https://github.com/microsoft/vscode) | ||
| - Formatting with [Prettier](https://github.com/prettier/prettier) | ||
| - Lint code with [ESLint](https://github.com/eslint/eslint) | ||
| - Lint markdown with [markdownlint](https://github.com/DavidAnson/markdownlint) | ||
| - Package management with [pnpm](https://github.com/pnpm/pnpm) | ||
| - Publish it with a GitHub Workflow | ||
| - Run it with [tsx](https://github.com/privatenumber/tsx) | ||
| - Run your GitHub Actions locally with [`act`](https://github.com/nektos/act) | ||
| - Unit tests with [Vitest](https://github.com/vitest-dev/vitest) | ||
|
|
||
| ## Publishing | ||
|
|
||
| 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. | ||
|
|
||
| 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). | ||
|
|
||
| 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> | ||
|
|
||
| ```sh | ||
| ssh-keygen -t ed25519 -C "@natoboram/gigachad.ts" -f new_ssh_key -N "" | ||
| ``` | ||
|
|
||
| 2. Add the private key to your project's secrets at `/settings/secrets/actions/new` with the name `DEPLOY_KEY_PRIVATE` | ||
| 3. Add the public key to your project's variables at `/settings/variables/actions/new` with the name `DEPLOY_KEY_PUBLIC` | ||
| 4. Add the public key to your project's deploy keys at `/settings/keys` | ||
| 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 | ||
| 6. Delete the key pair from your computer, never to be seen again | ||
|
|
||
| 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`. | ||
|
|
||
| To publish on NPM, you'll need to provide your NPM token. | ||
|
|
||
| 1. Sign in to <https://www.npmjs.com> | ||
| 2. Access Tokens / Generate New Token / Classic Token / Automation / Generate Token | ||
| 3. Copy that token and save it in your project's secrets at `/settings/secrets/actions/new` with the name `NODE_AUTH_TOKEN` | ||
| CodeRabbit's TypeScript API client for connecting to Bitbucket Cloud and Bitbucker Data Center. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.