rconfighub/vector-server-pkg

There is no license information available for the latest version (v1.0.20) of this package.

A package for managing data sync with rConfig Vector agent software

v1.0.20 2025-07-11 13:24 UTC

README

Pre-requisites

  • Determine the next version number (e.g., v1.0.16)
  • Ensure all changes are ready for release

Step-by-Step Process

1. Create and Switch to New Branch

 cd ../vector-server-pkg/
git checkout -b release/v1.0.20

2. Make Your Changes

  • Implement all necessary code changes
  • Test thoroughly

3. Update Composer Version

  • Open composer.json in the rconfig/vector-server repository
  • Update the version field:
"version": "v1.0.18"

Note: Consider removing the version field entirely and let Composer infer from Git tags

4. Commit Changes

git add .
git commit -m "Prepare release v1.0.20"

5. Merge to Main Branch

git checkout main
git merge release/v1.0.19
git push origin main

6. Create and Push Git Tag

git tag -a v1.0.18 -m "Release version v1.0.18"
git push origin v1.0.18

7. Clear Composer Cache and Update

composer clear-cache
composer update

8. Clear rConfig Cache

php artisan rconfig:clear-all

9. Create GitHub Release

  • Go to GitHub repository
  • Create new release using the v1.0.16 tag
  • Add release notes describing changes

10. Update Package Repository

  • Ensure package is updated in Repman
  • Verify Packagist update if applicable

If You Need to Fix an Incorrect Tag

If you created the wrong tag or it points to the wrong commit:

# Delete incorrect tag locally and remotely
git tag -d v1.0.16
git push origin :refs/tags/v1.0.16

# Create correct tag on the right commit
git checkout [correct-commit-hash]
git tag -a v1.0.16 -m "Release version v1.0.16"
git push origin v1.0.16

Best Practices

  1. Use semantic versioning (MAJOR.MINOR.PATCH)
  2. Test before tagging - Run all tests in the rConfig V7 test suite
  3. Consistent naming - Use the same version number throughout the process
  4. Clean git history - Use meaningful commit messages
  5. Document changes - Include clear release notes in GitHub releases