Update Git workflow documentation for better collaboration and testing
This commit is contained in:
81
.github/ai-workflows/release-process.md
vendored
81
.github/ai-workflows/release-process.md
vendored
@ -15,6 +15,7 @@ This document provides step-by-step instructions for AI assistants to help with
|
||||
Based on the changes made, determine the appropriate version increment:
|
||||
|
||||
1. **PATCH** (e.g., 1.6.0 → 1.6.1): For bug fixes and minor improvements
|
||||
- **IMPORTANT**: Always increment the patch version for every change, even small ones, to make rollbacks easier if issues are found in testing
|
||||
2. **MINOR** (e.g., 1.6.0 → 1.7.0): For new features and significant improvements
|
||||
3. **MAJOR** (e.g., 1.6.0 → 2.0.0): For breaking changes
|
||||
|
||||
@ -72,7 +73,16 @@ Add a new section at the top of the CHANGELOG.md file:
|
||||
- Bug fix 2
|
||||
```
|
||||
|
||||
#### c. readme.txt
|
||||
#### c. POT File (languages/fix-plugin-does-not-exist-notices.pot)
|
||||
|
||||
Update the Project-Id-Version and POT-Creation-Date:
|
||||
|
||||
```
|
||||
"Project-Id-Version: Fix 'Plugin file does not exist.' Notices {MAJOR}.{MINOR}.{PATCH}\n"
|
||||
"POT-Creation-Date: YYYY-MM-DDT00:00:00+00:00\n"
|
||||
```
|
||||
|
||||
#### d. readme.txt
|
||||
|
||||
Update the stable tag:
|
||||
|
||||
@ -102,18 +112,38 @@ Brief description of the most important changes in this release
|
||||
### 3. Commit Changes
|
||||
|
||||
```bash
|
||||
git add fix-plugin-does-not-exist-notices.php CHANGELOG.md readme.txt
|
||||
git add fix-plugin-does-not-exist-notices.php CHANGELOG.md readme.txt README.md languages/fix-plugin-does-not-exist-notices.pot
|
||||
git commit -m "Prepare release v{MAJOR}.{MINOR}.{PATCH}"
|
||||
```
|
||||
|
||||
### 4. Push Branch to Remotes
|
||||
### 4. Test Changes Locally
|
||||
|
||||
Test the changes thoroughly on the version branch to ensure everything works as expected:
|
||||
|
||||
- Test with the latest WordPress version
|
||||
- Test with PHP 7.0+ (minimum supported version)
|
||||
- Verify all features work as expected
|
||||
- Check for any PHP warnings or notices
|
||||
|
||||
### 5. Merge to Main
|
||||
|
||||
When satisfied with testing, merge the version branch to main:
|
||||
|
||||
```bash
|
||||
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
|
||||
```
|
||||
|
||||
### 5. Create and Push Tag
|
||||
The `--no-ff` flag creates a merge commit even if a fast-forward merge is possible, which helps preserve the branch history.
|
||||
|
||||
### 6. Push Main to Remotes
|
||||
|
||||
```bash
|
||||
git push github main
|
||||
git push gitea main
|
||||
```
|
||||
|
||||
### 7. Create and Push Tag
|
||||
|
||||
```bash
|
||||
git tag -a v{MAJOR}.{MINOR}.{PATCH} -m "Release version {MAJOR}.{MINOR}.{PATCH}"
|
||||
@ -121,17 +151,29 @@ git push github refs/tags/v{MAJOR}.{MINOR}.{PATCH}
|
||||
git push gitea refs/tags/v{MAJOR}.{MINOR}.{PATCH}
|
||||
```
|
||||
|
||||
### 6. Monitor GitHub Actions
|
||||
### 8. Monitor GitHub Actions
|
||||
|
||||
Open the GitHub Actions page to monitor the build and deployment process:
|
||||
https://github.com/wpallstars/fix-plugin-does-not-exist-notices/actions
|
||||
|
||||
### 7. Verify Release
|
||||
### 9. Verify Release
|
||||
|
||||
- [ ] Check that the GitHub release was created successfully
|
||||
- [ ] Verify that the plugin was deployed to WordPress.org
|
||||
- [ ] Test the plugin from WordPress.org to ensure it works correctly
|
||||
|
||||
## Testing Previous Versions
|
||||
|
||||
To test a previous version of the plugin:
|
||||
|
||||
```bash
|
||||
# Checkout a specific tag for testing
|
||||
git checkout v{MAJOR}.{MINOR}.{PATCH}
|
||||
|
||||
# Or create a test branch from a specific tag
|
||||
git checkout v{MAJOR}.{MINOR}.{PATCH} -b test/some-feature
|
||||
```
|
||||
|
||||
## Rollback Procedure (If Needed)
|
||||
|
||||
If issues are discovered after release:
|
||||
@ -151,16 +193,27 @@ Make the necessary changes to fix the issues.
|
||||
|
||||
Increment the PATCH version and update all version numbers as described above.
|
||||
|
||||
### 4. Commit and Push
|
||||
### 4. Test the Hotfix
|
||||
|
||||
Test the hotfix thoroughly to ensure it resolves the issue without introducing new problems.
|
||||
|
||||
### 5. Commit Changes
|
||||
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "Fix issues in v{MAJOR}.{MINOR}.{PATCH}"
|
||||
git push github HEAD:hotfix/v{MAJOR}.{MINOR}.{PATCH+1}
|
||||
git push gitea HEAD:hotfix/v{MAJOR}.{MINOR}.{PATCH+1}
|
||||
```
|
||||
|
||||
### 5. Create and Push Tag
|
||||
### 6. Merge to Main
|
||||
|
||||
```bash
|
||||
git checkout main
|
||||
git merge hotfix/v{MAJOR}.{MINOR}.{PATCH+1} --no-ff
|
||||
git push github main
|
||||
git push gitea main
|
||||
```
|
||||
|
||||
### 7. Create and Push Tag
|
||||
|
||||
```bash
|
||||
git tag -a v{MAJOR}.{MINOR}.{PATCH+1} -m "Hotfix release version {MAJOR}.{MINOR}.{PATCH+1}"
|
||||
@ -168,6 +221,6 @@ git push github refs/tags/v{MAJOR}.{MINOR}.{PATCH+1}
|
||||
git push gitea refs/tags/v{MAJOR}.{MINOR}.{PATCH+1}
|
||||
```
|
||||
|
||||
### 6. Monitor and Verify
|
||||
### 8. Monitor and Verify
|
||||
|
||||
Follow steps 6 and 7 from the release process to monitor and verify the hotfix release.
|
||||
Follow steps 8 and 9 from the release process to monitor and verify the hotfix release.
|
||||
|
Reference in New Issue
Block a user