Skip to content

Commit

Permalink
docs: complete deployment bump docs (#216)
Browse files Browse the repository at this point in the history
Co-authored-by: b00f <[email protected]>
  • Loading branch information
sepehr-dh99 and b00f authored Dec 30, 2024
1 parent c046fcb commit c8866af
Showing 1 changed file with 18 additions and 12 deletions.
30 changes: 18 additions & 12 deletions deployment/README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,33 @@
## Auto-Deployment for Pagu Project
## Pagu Deployment

This project includes an automated deployment process for
both the `stable` and `latest` versions of the Pagu Discord and Telegram bots.
This project includes an automated deployment process for both the `stable` and `latest` versions of the Pagu bots.

### Deployment Overview

The deployment system uses the following mechanisms:
The deployment system operates as follows:

- **Stable Version**: Activated when a Git tag is pushed to the repository.
- **Latest Version**: Activated when changes are pushed to the `main` branch.
- **Stable Version**: Triggered when a new stable version is released.
- **Latest Version**: Triggered when changes are pushed to the `main` branch.

### How to Create a Tag:
### Releasing a Stable Version

To create a tag and push it to the repository, follow these steps:
To release and deploy a stable version, create a Git tag and push it to the repository. Follow these steps:

1. Ensure that the origin is set to the current repository, not your fork.
2. Ensure that the Pagu's [version](../version.go) is updated.
1. Ensure that the `origin` remote points to the current repository, not your fork.
2. Verify that Pagu's [version](../version.go) is updated and matches the release version.
3. Run the following commands:

```bash
VERSION=0.x.y # Replace x and y with the latest version numbers
VERSION=0.x.y # Should match the release version
git checkout main
git pull origin
git pull
git tag -s -a v${VERSION} -m "Version ${VERSION}"
git push origin v${VERSION}
```

After creating the tag, the stable version will be released, and the deployment process will be triggered automatically.

### Updating the Working Version

Once a stable version is released, immediately update the [version.go](../version.go) file and open a Pull Request.
For reference, you can check this [Pull Request](https://github.com/pagu-project/pagu/pull/215).

0 comments on commit c8866af

Please sign in to comment.