Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Versions in README.md during Release Workflow #165

Open
dheid opened this issue Nov 20, 2023 · 0 comments
Open

Update Versions in README.md during Release Workflow #165

dheid opened this issue Nov 20, 2023 · 0 comments
Assignees

Comments

@dheid
Copy link
Collaborator

dheid commented Nov 20, 2023

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:

  1. Trigger the release Workflow.
  2. 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.

@dheid dheid self-assigned this Nov 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant