mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-09-11 02:55:51 +00:00
docs: update README with new branch strategy and RC automation workflow
This commit is contained in:
@@ -709,20 +709,54 @@ To update a tarball installation:
|
||||
|
||||
If running from source code:
|
||||
|
||||
**For stable releases (production):**
|
||||
```bash
|
||||
cd /path/to/pulse
|
||||
git checkout main
|
||||
git pull origin main
|
||||
npm install
|
||||
npm run build:css
|
||||
npm run start # or your preferred restart method
|
||||
```
|
||||
|
||||
**Note:** The development setup only requires npm install in the root directory, not in a separate server directory.
|
||||
**For development/RC versions:**
|
||||
```bash
|
||||
cd /path/to/pulse
|
||||
git checkout develop
|
||||
git pull origin develop
|
||||
npm install
|
||||
npm run build:css
|
||||
npm run start # or your preferred restart method
|
||||
```
|
||||
|
||||
**Note:**
|
||||
- The development setup only requires npm install in the root directory, not in a separate server directory.
|
||||
- The `develop` branch shows dynamic RC versions (e.g., "3.24.0-rc5") that auto-increment with each commit.
|
||||
- The `main` branch contains stable releases only.
|
||||
|
||||
## 📝 Contributing
|
||||
|
||||
Contributions are welcome! Please read our [Contributing Guidelines](CONTRIBUTING.md).
|
||||
|
||||
### Development Workflow
|
||||
|
||||
**Branch Strategy:**
|
||||
- `main` - Stable releases only (protected)
|
||||
- `develop` - Daily development work (default working branch)
|
||||
|
||||
**Release Candidate (RC) Automation:**
|
||||
- Every commit to `develop` automatically creates an RC release
|
||||
- RC versions increment automatically: `v3.24.0-rc1`, `v3.24.0-rc2`, etc.
|
||||
- Docker images are built for both `amd64` and `arm64` architectures
|
||||
- Local development shows dynamic RC versions that update with each commit
|
||||
|
||||
**Making Contributions:**
|
||||
1. Fork the repository
|
||||
2. Create a feature branch from `develop`
|
||||
3. Make your changes
|
||||
4. Test locally (version will show as RC automatically)
|
||||
5. Submit a pull request to `develop`
|
||||
|
||||
## 🔒 Privacy
|
||||
|
||||
* **No Data Collection:** Pulse does not collect or transmit any telemetry or user data externally.
|
||||
|
||||
Reference in New Issue
Block a user