Skip to content

Commit

Permalink
Remove versioning stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
dougollerenshaw committed Sep 19, 2024
1 parent b0b4405 commit 89198ed
Show file tree
Hide file tree
Showing 5 changed files with 1 addition and 141 deletions.
16 changes: 0 additions & 16 deletions .bumpversion.cfg

This file was deleted.

6 changes: 0 additions & 6 deletions .cz.toml

This file was deleted.

55 changes: 0 additions & 55 deletions .github/workflows/bump_version.yml

This file was deleted.

61 changes: 0 additions & 61 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,66 +106,5 @@ CodeAIde is an experimental tool and should be used with caution. Always review
For any questions or feedback, please [open an issue](https://github.com/dougollerenshaw/CodeAIde/issues) on the GitHub repository or email me directly at [[email protected]](mailto:[email protected]).
## Versioning and Releases
### Versioning Process
We use [Commitizen](https://commitizen-tools.github.io/commitizen/) to manage versioning based on conventional commits. The version is automatically bumped, and a changelog is generated when changes are pushed to the `release` branch.
### Creating a Release
To create a new release, follow these steps:
1. **Create a Release Branch**:
- Create a new branch from `main` named `release`.
```
git checkout main
git pull origin main
git checkout -b release
git push origin release
```
2. **Prepare the Release**:
- Make any necessary changes in the release branch, including version bumps and changelog updates.
- Push the changes to the release branch to trigger the release workflow.
### Version Bump and Release Workflow
The following steps are automatically performed by the GitHub Actions workflow when changes are pushed to the `release` branch:
- **Check out Code**:
The workflow checks out the code with full history to ensure version bumps are accurate.
- **Set up Python**:
The workflow sets up the Python environment.
- **Install Dependencies**:
The workflow installs the required dependencies.
- **Configure Git**:
The workflow configures Git with a bot user.
- **Bump Version**:
The workflow uses Commitizen to bump the version and update `version.py`.
- **Commit and Push Changes**:
The workflow commits and pushes the changes to the release branch, including tags.
- **Create GitHub Release**:
The workflow creates a GitHub release with the new version.
3. **Merge Back to Main**:
Once the release is finalized, merge the `release` branch back into `main` and tag the new version.
```
git checkout main
git pull origin main
git merge release
git push origin main
```
---
**Note:** This project is currently in development. Features and usage may change as the project evolves.
4 changes: 1 addition & 3 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,4 @@ pytest
black
isort
pre-commit
pyqt5
bump2version
commitizen
pyqt5

0 comments on commit 89198ed

Please sign in to comment.