Merge pull request #1 from trieb-work/feat-repo-name

feat: add repo starter command

Author: tilman

.github/workflows/ci.yml

@@ -11,6 +11,8 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write # Grant write access to pull request comments
 
     steps:
       - name: Checkout code

CHANGELOG.md

@@ -1,78 +0,0 @@
-# 1.0.0 (2024-11-19)
-
-
-### Bug Fixes
-
-* ci semantic release check ([df27fd8](https://github.com/trieb-work/next-optimized-redis-cache/commit/df27fd8228f95160603a000d917e1fa63a192319))
-* ci token ([6162dd9](https://github.com/trieb-work/next-optimized-redis-cache/commit/6162dd967386e6a55ee9cc909dd8c141cfa42018))
-* deps + fix: ci ([fe897c9](https://github.com/trieb-work/next-optimized-redis-cache/commit/fe897c931ba4fe1bcaec4ac4c1ebbbc81ca607a3))
-* deps + fix: ci ([eee7ca9](https://github.com/trieb-work/next-optimized-redis-cache/commit/eee7ca9b272aff595071084b812fcb0174caeee2))
-* git hooks ([69b1c2f](https://github.com/trieb-work/next-optimized-redis-cache/commit/69b1c2f922e85bd3ffeed42bc0e1be52c6fcf4e1))
-* move to dev packages ([e9c61c0](https://github.com/trieb-work/next-optimized-redis-cache/commit/e9c61c01ea092e55d47c559aafb2d29feaf89998))
-* public access ([cfe2845](https://github.com/trieb-work/next-optimized-redis-cache/commit/cfe2845b6e4a9b6f496a7d39f752b767c7670f93))
-* readme ([0129431](https://github.com/trieb-work/next-optimized-redis-cache/commit/0129431b40b017cab8f5192b1bffeae7d1bfa2be))
-* skip git setup in CI ([da64554](https://github.com/trieb-work/next-optimized-redis-cache/commit/da645547cef52b8d0a5cf59133d4184033c3ea60))
-
-
-### Features
-
-* add coverage comment ([a2b8a18](https://github.com/trieb-work/next-optimized-redis-cache/commit/a2b8a18497e08790f3ebb8bb3f7f92b9de3690a5))
-* add coverage comment ([535c393](https://github.com/trieb-work/next-optimized-redis-cache/commit/535c393e20cbebec85d552eb9a7c3ca1346bdb4b))
-* add main protection ([e920d5d](https://github.com/trieb-work/next-optimized-redis-cache/commit/e920d5d4705118950830cd4fa9be4cdc033c07fb))
-* add vitest only to staged files ([f2f2156](https://github.com/trieb-work/next-optimized-redis-cache/commit/f2f2156e1b06679ed9d634545c958765e94e3b6c))
-* add vitest only to staged files ([5001642](https://github.com/trieb-work/next-optimized-redis-cache/commit/5001642c71a8f120cf78079cd954df37018cc2ec))
-* add vitest only to staged files ([02f83ee](https://github.com/trieb-work/next-optimized-redis-cache/commit/02f83ee1d4c53d8958d986aa43f8ce8b198971fe))
-* add vitest only to staged files ([9004ef7](https://github.com/trieb-work/next-optimized-redis-cache/commit/9004ef7f9fb6e244110bc8c5895de0aae9b8b965))
-* add vitest only to staged files ([b228ef1](https://github.com/trieb-work/next-optimized-redis-cache/commit/b228ef1f505f2253eb822cd3a68ec604eb7fac09))
-* add vitest only to staged files ([c246f10](https://github.com/trieb-work/next-optimized-redis-cache/commit/c246f1087f104f4080dd1ee59630c7db8180a71a))
-* add vitest only to staged files ([2353a2d](https://github.com/trieb-work/next-optimized-redis-cache/commit/2353a2ddce9973d390cb37c450faf7654804ac4f))
-* change to triebwork namespace ([7d6722f](https://github.com/trieb-work/next-optimized-redis-cache/commit/7d6722fa5668b41356721a4f18b1a03d0ebde992))
-* change to vitest + feat: add lint-staged ([d9412ae](https://github.com/trieb-work/next-optimized-redis-cache/commit/d9412aeaa0f9671f7289d2cea0e28baa48de49a1))
-* changed staged commits ([e464894](https://github.com/trieb-work/next-optimized-redis-cache/commit/e464894b0ca024d4e7d552ef3497d7d405aeab72))
-* initial commit ([85fc4f3](https://github.com/trieb-work/next-optimized-redis-cache/commit/85fc4f3c0b022ed35be8466e005422cc0d3a96c8))
-* run only vitest on staged ([f48cdbf](https://github.com/trieb-work/next-optimized-redis-cache/commit/f48cdbf1cc5961a68ba472ba19503308d8368295))
-* run only vitest on staged ([82a6757](https://github.com/trieb-work/next-optimized-redis-cache/commit/82a6757ac82d82c054a5842fbaf44da99ceb3f63))
-* update conf ([9c3623a](https://github.com/trieb-work/next-optimized-redis-cache/commit/9c3623ab9a0b09f9e3de29baecead33102796792))
-* update conf ([7d31a37](https://github.com/trieb-work/next-optimized-redis-cache/commit/7d31a3778f21df681c1e4e4d7677c344a86086a5))
-* update hooks ([7c04a6e](https://github.com/trieb-work/next-optimized-redis-cache/commit/7c04a6e4c4afd513737f37f8e1276f1ac92bd781))
-* update hooks ([610a94c](https://github.com/trieb-work/next-optimized-redis-cache/commit/610a94cf4728ccb728c99f73307379d2630909a0))
-* update hooks ([dfaf36b](https://github.com/trieb-work/next-optimized-redis-cache/commit/dfaf36be23c8d78337c4610725374590b3ddf434))
-* update hooks ([b892230](https://github.com/trieb-work/next-optimized-redis-cache/commit/b89223020b6ec6d2d94110dd66d12beafc1cd828))
-
-# [1.0.0-beta.3](https://github.com/trieb-work/next-optimized-redis-cache/compare/v1.0.0-beta.2...v1.0.0-beta.3) (2024-11-19)
-
-### Bug Fixes
-
-- move to dev packages ([e9c61c0](https://github.com/trieb-work/next-optimized-redis-cache/commit/e9c61c01ea092e55d47c559aafb2d29feaf89998))
-
-# [1.0.0-beta.2](https://github.com/trieb-work/next-optimized-redis-cache/compare/v1.0.0-beta.1...v1.0.0-beta.2) (2024-11-19)
-
-### Bug Fixes
-
-- public access ([cfe2845](https://github.com/trieb-work/next-optimized-redis-cache/commit/cfe2845b6e4a9b6f496a7d39f752b767c7670f93))
-
-# 1.0.0-beta.1 (2024-11-19)
-
-### Bug Fixes
-
-- ci semantic release check ([df27fd8](https://github.com/trieb-work/next-optimized-redis-cache/commit/df27fd8228f95160603a000d917e1fa63a192319))
-- ci token ([6162dd9](https://github.com/trieb-work/next-optimized-redis-cache/commit/6162dd967386e6a55ee9cc909dd8c141cfa42018))
-- deps + fix: ci ([fe897c9](https://github.com/trieb-work/next-optimized-redis-cache/commit/fe897c931ba4fe1bcaec4ac4c1ebbbc81ca607a3))
-- deps + fix: ci ([eee7ca9](https://github.com/trieb-work/next-optimized-redis-cache/commit/eee7ca9b272aff595071084b812fcb0174caeee2))
-- git hooks ([69b1c2f](https://github.com/trieb-work/next-optimized-redis-cache/commit/69b1c2f922e85bd3ffeed42bc0e1be52c6fcf4e1))
-
-### Features
-
-- add coverage comment ([a2b8a18](https://github.com/trieb-work/next-optimized-redis-cache/commit/a2b8a18497e08790f3ebb8bb3f7f92b9de3690a5))
-- add coverage comment ([535c393](https://github.com/trieb-work/next-optimized-redis-cache/commit/535c393e20cbebec85d552eb9a7c3ca1346bdb4b))
-- add main protection ([e920d5d](https://github.com/trieb-work/next-optimized-redis-cache/commit/e920d5d4705118950830cd4fa9be4cdc033c07fb))
-- change to triebwork namespace ([7d6722f](https://github.com/trieb-work/next-optimized-redis-cache/commit/7d6722fa5668b41356721a4f18b1a03d0ebde992))
-- change to vitest + feat: add lint-staged ([d9412ae](https://github.com/trieb-work/next-optimized-redis-cache/commit/d9412aeaa0f9671f7289d2cea0e28baa48de49a1))
-- changed staged commits ([e464894](https://github.com/trieb-work/next-optimized-redis-cache/commit/e464894b0ca024d4e7d552ef3497d7d405aeab72))
-- initial commit ([85fc4f3](https://github.com/trieb-work/next-optimized-redis-cache/commit/85fc4f3c0b022ed35be8466e005422cc0d3a96c8))
-- update conf ([9c3623a](https://github.com/trieb-work/next-optimized-redis-cache/commit/9c3623ab9a0b09f9e3de29baecead33102796792))
-- update conf ([7d31a37](https://github.com/trieb-work/next-optimized-redis-cache/commit/7d31a3778f21df681c1e4e4d7677c344a86086a5))
-- update hooks ([7c04a6e](https://github.com/trieb-work/next-optimized-redis-cache/commit/7c04a6e4c4afd513737f37f8e1276f1ac92bd781))
-- update hooks ([610a94c](https://github.com/trieb-work/next-optimized-redis-cache/commit/610a94cf4728ccb728c99f73307379d2630909a0))
-- update hooks ([dfaf36b](https://github.com/trieb-work/next-optimized-redis-cache/commit/dfaf36be23c8d78337c4610725374590b3ddf434))
-- update hooks ([b892230](https://github.com/trieb-work/next-optimized-redis-cache/commit/b89223020b6ec6d2d94110dd66d12beafc1cd828))

README.md

@@ -16,12 +16,18 @@ This is a template for creating a TypeScript package.
 
 ## Getting Started
 
-1. Clone the repository
-2. For private repos: set NPM_TOKEN in repository secrets (For public repos, it is already set via organization secrets)
-3. Run `pnpm install` to install the dependencies
-4. Run `pnpm run build` to build the project
-5. Run `pnpm run dev` to develop the project
-6. Run `pnpm run test` to test the project
+1. Create a new repo using this as template repo
+2. Clone the new repository
+3. Run ./scripts/setup-repo-name.sh to configure the package name in all files
+4. For private repos: set NPM_TOKEN in repository secrets (For public repos, it is already set via organization secrets)
+5. Run `pnpm install` to install the dependencies
+6. Run `pnpm run build` to build the project
+7. Run `pnpm run dev` to develop the project
+8. Run `pnpm run test` to test the project
+10. Checkout into a new branch (main is protected)
+11. Change code and commit it using conventional commit. Staged code will get checked
+12. Push and create a PR (against main or beta) to run CI
+13. Merge to main or beta to create a release or pre-release 
 
 ## License
 

README_FINAL.md

@@ -0,0 +1,16 @@
+# public-typescript-npm-package-starter NPM Package
+
+## Getting Started
+
+5. Run `pnpm install` to install the dependencies
+6. Run `pnpm run build` to build the project
+7. Run `pnpm run dev` to develop the project
+8. Run `pnpm run test` to test the project
+10. Checkout into a new branch (main is protected)
+11. Change code and commit it using conventional commit. Staged code will get checked
+12. Push and create a PR (against main or beta) to run CI
+13. Merge to main or beta to create a release or pre-release 
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@trieb.work/next-optimized-redis-cache",
+  "name": "@trieb.work/public-typescript-npm-package-starter",
   "version": "1.0.0",
   "scripts": {
     "dev": "vitest --watch",
@@ -16,7 +16,7 @@
   "keywords": [],
   "author": "",
   "license": "ISC",
-  "description": "A fast, optimized Redis cache for Next.js",
+  "description": "",
   "publishConfig": {
     "access": "public"
   },
@@ -48,4 +48,4 @@
     "vitest": "^2.1.5"
   },
   "dependencies": {}
-}
+}

scripts/setup-repo-name.sh

@@ -0,0 +1,17 @@
+#!/bin/sh
+# Get the remote repository URL
+REPO_URL=$(git config --get remote.origin.url)
+
+# Extract the repository name from the URL
+REPO_NAME=$(basename -s .git "$REPO_URL")
+echo "Renaming package to: $REPO_NAME"
+
+# Rename README_FINAL.md to README.md
+mv README_FINAL.md README.md
+
+# Replace placeholders in regular files only
+for file in *; do
+  if [ -f "$file" ]; then
+    sed -i '' "s/public-typescript-npm-package-starter/$REPO_NAME/g" "$file"
+  fi
+done