Skip to content

Commit 5153ec4

Browse files
ozgesolidkeyclaude
andcommitted
Switch to GitHub Packages for npm distribution
- Change package name from @solidkey to @SolidKeyAB (matches GitHub org) - Add publishConfig for GitHub Packages registry - Update README with GitHub Packages installation instructions - Update all orchestrate.sh templates with new package name - Add .npmignore for cleaner package distribution 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent b067e1d commit 5153ec4

File tree

5 files changed

+71
-21
lines changed

5 files changed

+71
-21
lines changed

.npmignore

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Git
2+
.git/
3+
.github/
4+
5+
# Development
6+
.vscode/
7+
.idea/
8+
*.log
9+
*.swp
10+
*.swo
11+
12+
# Emulator data
13+
emulator-data/
14+
firebase-export*/
15+
16+
# Test & local development
17+
.env
18+
.env.*
19+
*.local
20+
21+
# OS files
22+
.DS_Store
23+
Thumbs.db
24+
25+
# Package files
26+
node_modules/
27+
package-lock.json
28+
29+
# Documentation extras (keep main docs)
30+
CONTRIBUTING.md

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
> **Enterprise-grade Firebase DevOps - Local to Production in Minutes**
44
5-
[![npm version](https://badge.fury.io/js/%40solidkey%2Ffirebase-devops-toolkit.svg)](https://www.npmjs.com/package/@solidkey/firebase-devops-toolkit)
5+
[![GitHub Package](https://img.shields.io/badge/npm-GitHub%20Packages-blue)](https://github.com/SolidKeyAB/firebase-devops-toolkit/packages)
66
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
77
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
88

@@ -97,21 +97,29 @@ The starter template includes:
9797
- Pre-configured orchestrate.sh
9898
- Ready-to-use emulator config
9999

100-
### Option B: Add to Existing Project
100+
### Option B: Add to Existing Project (via GitHub Packages)
101101

102102
```bash
103-
# Install via npm
103+
# Configure npm to use GitHub Packages for @solidkeyab scope
104+
echo "@solidkeyab:registry=https://npm.pkg.github.com" >> .npmrc
105+
106+
# Install the toolkit
104107
cd your-project/services
105-
npm install @solidkey/firebase-devops-toolkit --save-dev
108+
npm install @solidkeyab/firebase-devops-toolkit --save-dev
106109

107110
# Copy the orchestration script
108-
cp node_modules/@solidkey/firebase-devops-toolkit/templates/orchestrate.sh ../scripts/
111+
cp node_modules/@solidkeyab/firebase-devops-toolkit/templates/orchestrate.sh ../scripts/
109112

110113
# Set your project ID and start
111114
export FIREBASE_PROJECT_ID="your-project-id"
112115
./scripts/orchestrate.sh dev
113116
```
114117

118+
> **Note:** GitHub Packages requires authentication. Create a [Personal Access Token](https://github.com/settings/tokens) with `read:packages` scope and run:
119+
> ```bash
120+
> npm login --registry=https://npm.pkg.github.com
121+
> ```
122+
115123
### Option C: Standalone Installation
116124
117125
```bash
@@ -251,7 +259,7 @@ The `templates/orchestrate.sh` provides a project wrapper that:
251259

252260
```bash
253261
# Copy and customize
254-
cp node_modules/@solidkey/firebase-devops-toolkit/templates/orchestrate.sh ./scripts/
262+
cp node_modules/@solidkeyab/firebase-devops-toolkit/templates/orchestrate.sh ./scripts/
255263

256264
# Your custom commands
257265
./scripts/orchestrate.sh start-dev # Your project-specific

package.json

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"name": "@solidkey/firebase-devops-toolkit",
3-
"version": "1.0.0",
2+
"name": "@solidkeyab/firebase-devops-toolkit",
3+
"version": "0.1.0",
44
"description": "Enterprise-grade Firebase DevOps toolkit - 80+ production-ready scripts for local development, deployment, and team collaboration",
55
"main": "manage.sh",
66
"scripts": {
@@ -32,6 +32,9 @@
3232
"url": "https://github.com/SolidKeyAB/firebase-devops-toolkit/issues"
3333
},
3434
"homepage": "https://github.com/SolidKeyAB/firebase-devops-toolkit#readme",
35+
"publishConfig": {
36+
"registry": "https://npm.pkg.github.com"
37+
},
3538
"engines": {
3639
"node": ">=18.0.0"
3740
},

templates/orchestrate.sh

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
# =============================================================================
66
#
77
# This is a template for your project-specific orchestration script.
8-
# It wraps @solidkey/firebase-devops-toolkit and adds project-specific commands.
8+
# It wraps @solidkeyab/firebase-devops-toolkit and adds project-specific commands.
99
#
1010
# USAGE:
1111
# 1. Copy this file to your project: cp orchestrate.sh your-project/scripts/
@@ -14,7 +14,11 @@
1414
# 4. Run: ./scripts/orchestrate.sh [command]
1515
#
1616
# INSTALLATION METHODS (choose one):
17-
# npm install @solidkey/firebase-devops-toolkit --save-dev
17+
# # Via GitHub Packages:
18+
# echo "@solidkeyab:registry=https://npm.pkg.github.com" >> .npmrc
19+
# npm install @solidkeyab/firebase-devops-toolkit --save-dev
20+
#
21+
# # Via Git:
1822
# git submodule add https://github.com/SolidKeyAB/firebase-devops-toolkit.git
1923
# export FIREBASE_DEVOPS_DIR=/path/to/firebase-devops-toolkit
2024
#
@@ -56,8 +60,8 @@ find_firebase_devops() {
5660
return 0
5761
fi
5862

59-
# 2. npm package (recommended for most projects)
60-
local npm_path="$PROJECT_ROOT/node_modules/@solidkey/firebase-devops-toolkit"
63+
# 2. npm package via GitHub Packages (recommended for most projects)
64+
local npm_path="$PROJECT_ROOT/node_modules/@solidkeyab/firebase-devops-toolkit"
6165
if [ -f "$npm_path/manage.sh" ]; then
6266
echo "$npm_path"
6367
return 0
@@ -111,11 +115,12 @@ if [ -z "$FIREBASE_DEVOPS" ]; then
111115
echo ""
112116
echo "Install using one of these methods:"
113117
echo ""
114-
echo " # Option 1: npm (recommended)"
115-
echo " npm install @solidkey/firebase-devops-toolkit --save-dev"
118+
echo " # Option 1: GitHub Packages (recommended)"
119+
echo " echo '@solidkeyab:registry=https://npm.pkg.github.com' >> .npmrc"
120+
echo " npm install @solidkeyab/firebase-devops-toolkit --save-dev"
116121
echo ""
117-
echo " # Option 2: Git submodule"
118-
echo " git submodule add https://github.com/SolidKeyAB/firebase-devops-toolkit.git"
122+
echo " # Option 2: Git clone"
123+
echo " git clone https://github.com/SolidKeyAB/firebase-devops-toolkit.git"
119124
echo ""
120125
echo " # Option 3: Environment variable"
121126
echo " export FIREBASE_DEVOPS_DIR=/path/to/firebase-devops-toolkit"

templates/starter-project/scripts/orchestrate.sh

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# =============================================================================
44
# Project Orchestration Script
55
# =============================================================================
6-
# Wrapper for @solidkey/firebase-devops-toolkit
6+
# Wrapper for @solidkeyab/firebase-devops-toolkit
77
# Customize this for your project needs
88
# =============================================================================
99

@@ -22,8 +22,8 @@ export FIREBASE_REGION="${FIREBASE_REGION:-us-central1}"
2222
# =============================================================================
2323

2424
find_toolkit() {
25-
# 1. npm package
26-
local npm_path="$SERVICES_DIR/node_modules/@solidkey/firebase-devops-toolkit"
25+
# 1. npm package (GitHub Packages)
26+
local npm_path="$SERVICES_DIR/node_modules/@solidkeyab/firebase-devops-toolkit"
2727
[ -f "$npm_path/manage.sh" ] && echo "$npm_path" && return 0
2828

2929
# 2. Environment variable
@@ -40,8 +40,12 @@ TOOLKIT=$(find_toolkit)
4040
if [ -z "$TOOLKIT" ]; then
4141
echo "ERROR: Firebase DevOps Toolkit not found!"
4242
echo ""
43-
echo "Install it:"
44-
echo " cd services && npm install @solidkey/firebase-devops-toolkit"
43+
echo "Install it via GitHub Packages:"
44+
echo " echo '@solidkeyab:registry=https://npm.pkg.github.com' >> .npmrc"
45+
echo " cd services && npm install @solidkeyab/firebase-devops-toolkit"
46+
echo ""
47+
echo "Or clone directly:"
48+
echo " git clone https://github.com/SolidKeyAB/firebase-devops-toolkit.git"
4549
echo ""
4650
exit 1
4751
fi

0 commit comments

Comments
 (0)