-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b0b4405
commit 89198ed
Showing
5 changed files
with
1 addition
and
141 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,6 +6,4 @@ pytest | |
black | ||
isort | ||
pre-commit | ||
pyqt5 | ||
bump2version | ||
commitizen | ||
pyqt5 |