add yaml to how to update, and change branch in contributing

This commit is contained in:
Milo Schwartz 2025-01-21 16:21:46 -05:00
parent 3ef44f99db
commit be325469df
No known key found for this signature in database
2 changed files with 19 additions and 4 deletions

View file

@ -10,19 +10,32 @@ Some basic commands to get you started:
sudo docker compose down sudo docker compose down
``` ```
2. Pull the latest images 2. Update the docker compose file with the new version number
```yaml
services:
pangolin:
image: fosrl/pangolin:1.0.0-beta.8 # increase the tag to the latest version number, or use "latest"
container_name: pangolin
restart: unless-stopped
...
```
Do this for each container you want to update.
3. Pull the latest images
```bash ```bash
sudo docker compose pull sudo docker compose pull
``` ```
3. Start the stack 4. Start the stack
```bash ```bash
sudo docker compose up -d sudo docker compose up -d
``` ```
4. Check the logs 5. Check the logs
```bash ```bash
sudo docker compose logs -f sudo docker compose logs -f

View file

@ -34,7 +34,7 @@ Below is an example if you're working on the Pangolin repo.
3. Create a new branch: 3. Create a new branch:
```bash ```bash
git checkout -b BRANCH_NAME dev git checkout -b BRANCH_NAME main
``` ```
- It is recommended to give your branch a meaningful name, relevant to the feature or fix you are working on. - It is recommended to give your branch a meaningful name, relevant to the feature or fix you are working on.
@ -49,6 +49,8 @@ Below is an example if you're working on the Pangolin repo.
- `fix` - `fix`
- `patch` - `patch`
4. If you open a pull request, open it against the `main` branch of the original repository.
## Pangolin ## Pangolin
- NodeJS v20.10.0 - NodeJS v20.10.0