Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: complete deployment bump docs #216

Merged
merged 4 commits into from
Dec 30, 2024
Merged

docs: complete deployment bump docs #216

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ffc11b7
docs: complete deplyment bump docs
sepehr-dh99 Dec 29, 2024
267a5ef
fix: version bump PR example
sepehr-dh99 Dec 29, 2024
d0648ab
Update README.md
b00f Dec 30, 2024
38d5f0a
Merge branch 'main' into docs/deployments
sepehr-dh99 Dec 30, 2024
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
30 changes: 18 additions & 12 deletions deployment/README.md
View file
Open in desktop
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).
Loading