The current release script for our project lacks an essential step to keep the version information consistent across our documentation. Specifically, we need to update the versions in the Maven XML and Gradle Groovy snippets within the README.md file with the latest version from the Maven POM.
Proposed Solution:
Integrate a GitHub Actions step into the release script that automatically fetches the latest version from the Maven POM and updates the corresponding sections in README.md. It's crucial that this process doesn't rely on version placeholders but instead overwrites the existing version, commits the change, and pushes it during the execution of the release Workflow.
Steps to Reproduce:
Trigger the release Workflow.
Observe the README.md file for updated version information in Maven XML and Gradle Groovy snippets.
Expected Outcome:
The README.md file should reflect the latest version from the Maven POM after the release Workflow completes.
Additional Information:
Ensure that the script is well-documented and adheres to best practices. This enhancement will streamline version management across our documentation and build files, minimizing the risk of inconsistencies.
The current release script for our project lacks an essential step to keep the version information consistent across our documentation. Specifically, we need to update the versions in the Maven XML and Gradle Groovy snippets within the README.md file with the latest version from the Maven POM.
Proposed Solution: Integrate a GitHub Actions step into the release script that automatically fetches the latest version from the Maven POM and updates the corresponding sections in README.md. It's crucial that this process doesn't rely on version placeholders but instead overwrites the existing version, commits the change, and pushes it during the execution of the release Workflow.
Steps to Reproduce:
Expected Outcome: The README.md file should reflect the latest version from the Maven POM after the release Workflow completes.
Additional Information: Ensure that the script is well-documented and adheres to best practices. This enhancement will streamline version management across our documentation and build files, minimizing the risk of inconsistencies.