Update Git workflow documentation for better collaboration and testing

This commit is contained in:
2025-04-12 02:12:00 +01:00
parent bae264f655
commit 6b5267177f
4 changed files with 191 additions and 42 deletions

View File

@ -79,23 +79,30 @@ Before creating a new release, verify the following:
- `FPDEN_VERSION` constant in the main plugin file
- `readme.txt` (Stable tag)
- `README.md` (Ensure changelog is updated)
- `languages/fix-plugin-does-not-exist-notices.pot` (Project-Id-Version)
- Any other files that reference the version number
3. Update CHANGELOG.md with all changes
4. Update readme.txt changelog section
5. Update README.md changelog section to match readme.txt
6. Commit changes: `git commit -m "Prepare release v{MAJOR}.{MINOR}.{PATCH}"`
7. Push branch to all remotes:
7. Test changes locally on the version branch
8. When satisfied with testing, merge to main:
```
git push github HEAD:v{MAJOR}.{MINOR}.{PATCH}
git push gitea HEAD:v{MAJOR}.{MINOR}.{PATCH}
git checkout main
git merge v{MAJOR}.{MINOR}.{PATCH} --no-ff
```
8. Create and push a tag to trigger the GitHub Actions workflow:
9. Push main to all remotes:
```
git tag -a v{MAJOR}.{MINOR}.{PATCH} -m "Release version {MAJOR}.{MINOR}.{PATCH}"
git push github refs/tags/v{MAJOR}.{MINOR}.{PATCH}
git push gitea refs/tags/v{MAJOR}.{MINOR}.{PATCH}
git push github main
git push gitea main
```
9. Verify the GitHub Actions workflow completes successfully
10. Create and push a tag to trigger the GitHub Actions workflow:
```
git tag -a v{MAJOR}.{MINOR}.{PATCH} -m "Release version {MAJOR}.{MINOR}.{PATCH}"
git push github refs/tags/v{MAJOR}.{MINOR}.{PATCH}
git push gitea refs/tags/v{MAJOR}.{MINOR}.{PATCH}
```
11. Verify the GitHub Actions workflow completes successfully
## Build Process
@ -141,6 +148,7 @@ Before releasing:
```
# 1. Create a new branch
git checkout main
git checkout -b v1.7.0
# 2. Update version numbers in ALL required files
@ -148,17 +156,25 @@ git checkout -b v1.7.0
# - CHANGELOG.md
# - readme.txt
# - README.md
# - languages/fix-plugin-does-not-exist-notices.pot
# - FPDEN_VERSION constant
# 3. Commit changes
git add .
git commit -m "Prepare release v1.7.0"
# 4. Push to remotes
git push github HEAD:v1.7.0
git push gitea HEAD:v1.7.0
# 4. Test changes locally on the version branch
# (Run tests, verify functionality)
# 5. Create and push tag
# 5. Merge to main when ready
git checkout main
git merge v1.7.0 --no-ff
# 6. Push main to remotes
git push github main
git push gitea main
# 7. Create and push tag
git tag -a v1.7.0 -m "Release version 1.7.0"
git push github refs/tags/v1.7.0
git push gitea refs/tags/v1.7.0
@ -167,29 +183,53 @@ git push gitea refs/tags/v1.7.0
### Adding a New Feature
```
# 1. Create feature branch
# 1. Create feature branch from main
git checkout main
git checkout -b feature/new-feature-name
# 2. Make changes and commit
git add .
git commit -m "Add new feature"
# 3. Push to remotes
git push github HEAD:feature/new-feature-name
git push gitea HEAD:feature/new-feature-name
# 3. Test locally
# (Run tests, verify functionality)
# 4. When ready for release, merge to a version branch
git checkout -b v1.7.0
git merge feature/new-feature-name --no-ff
# 5. Continue with the release process
# (Update version numbers, etc.)
```
### Fixing a Bug
```
# 1. Create bugfix branch
# 1. Create bugfix branch from main
git checkout main
git checkout -b fix/bug-description
# 2. Make changes and commit
git add .
git commit -m "Fix #123: Fix bug description"
# 3. Push to remotes
git push github HEAD:fix/bug-description
git push gitea HEAD:fix/bug-description
# 3. Test locally
# (Run tests, verify functionality)
# 4. When ready for release, merge to a version branch
git checkout -b v1.6.5
git merge fix/bug-description --no-ff
# 5. Continue with the release process
# (Update version numbers, etc.)
```
### Testing a Previous Version
```
# Checkout a specific tag for testing
git checkout v1.6.3
# Or create a test branch from a specific tag
git checkout v1.6.3 -b test/some-feature
```