Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 8 additions & 28 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,36 +97,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

---

## Migration Guide
## Migration Notes

### From 0.x to 1.0
The project currently ships **probot ^14.2.4** and **@octokit/rest ^22.0.1**
(see `package.json`). Earlier versions of this CHANGELOG carried a stale
"install probot@^12, @octokit/rest@^19" instruction that no longer matches
reality and has been removed.

1. **Update package.json**
```bash
npm install probot@^12.0.0 @octokit/rest@^19.0.0
```

2. **Update configuration**
```yaml
# Update config.yml to match new format
```

3. **Review changes**
- New merge settings format
- Improved error handling
- Better logging

### From 1.x to 2.0 (Future)

1. **Update dependencies**
```bash
npm install probot@^13.0.0 @octokit/rest@^20.0.0
```

2. **Review breaking changes**
- New configuration format
- Updated API endpoints
- New authentication method
When a migration is actually needed for a future release, a `### From X.x
to Y.0` block describing the concrete steps will be added here at the time
of that release.

## Deprecation Policy

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ gh repo delete pulseengine/test-repo --confirm

### Running Tests

`npm test` runs 453 tests. See DEVELOPMENT.md for test structure details.
`npm test` runs the full Jest suite (unit + integration + smoke + e2e). See DEVELOPMENT.md for test structure details.

## Documentation

Expand Down
6 changes: 2 additions & 4 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,10 +227,8 @@ Bazel targets:
| `lint` | `eslint src/ index.js functions.js __tests__/` | Lint source and tests |
| `build` | `bazel build //...` | Bazel build |
| `bazel:test` | `bazel test //...` | Bazel test |
| `deploy:heroku` | `git push heroku main` | Deploy to Heroku |
| `deploy:docker` | `docker build && docker push` | Build and push Docker image |
| `deploy:server` | `pm2 restart/start` | Deploy with PM2 |
| `deploy:netcup` | `npm install --production` | Prepare for Netcup hosting |
| `docker:build` | `docker build -t temper .` | Build the multi-stage Alpine image |
| `setup` | `node scripts/setup.js` | Interactive bootstrap wizard (org, user, email) |

## Architecture

Expand Down
14 changes: 7 additions & 7 deletions GITHUB_APP_SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Subscribe to these events:
1. Click "Generate a private key" button
2. A `.pem` file will download automatically
3. **Save this file securely** - it cannot be retrieved again!
4. Store the key in your `.env` file as `GITHUB_PRIVATE_KEY`
4. Store the key in your `.env` file as `PRIVATE_KEY`

### Step 5: Install the App

Expand All @@ -68,9 +68,9 @@ cp .env.example .env
Edit the `.env` file with your actual credentials:

```
GITHUB_APP_ID=123456 # From GitHub App settings
GITHUB_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----..." # Contents of .pem file
GITHUB_WEBHOOK_SECRET=your_webhook_secret_here # From webhook setup
APP_ID=123456 # From GitHub App settings
PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----..." # Contents of .pem file
WEBHOOK_SECRET=your_webhook_secret_here # From webhook setup
PORT=3000
ORGANIZATION=pulseengine
```
Expand All @@ -89,9 +89,9 @@ npm start
```bash
docker build -t temper .
docker run -p 3000:3000 \
-e GITHUB_APP_ID=your_app_id \
-e GITHUB_PRIVATE_KEY="$(cat private-key.pem)" \
-e GITHUB_WEBHOOK_SECRET=your_webhook_secret \
-e APP_ID=your_app_id \
-e PRIVATE_KEY="$(cat private-key.pem)" \
-e WEBHOOK_SECRET=your_webhook_secret \
temper
```

Expand Down
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,10 +138,9 @@ See [DEVELOPMENT.md](DEVELOPMENT.md) for the full development guide.

## Deployment

- **Docker** — `npm run deploy:docker` builds and pushes a multi-stage Alpine image
- **Heroku** — `npm run deploy:heroku` pushes to Heroku via git
- **PM2** — `npm run deploy:server` starts or restarts the app under PM2
- **Netcup** — `npm run deploy:netcup` installs production dependencies for shared hosting
- **Docker** — `npm run docker:build` builds the multi-stage Alpine image; push and run via your registry/orchestrator of choice.
- **PM2** — production runs under PM2 (`pm2 start npm --name temper -- start`); self-update is wired so a push to `main` redeploys via the binary in `tools/self-update/`.
- **Netcup VPS** — current production target. Single host, 3.8 GB RAM, no swap; see `verify-netcup-deployment.sh` for the post-install checks.

## License

Expand Down
Loading