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

Add automatic updating of README #16

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add automatic updating of README #16

wants to merge 1 commit into from

Conversation

rnc
Copy link
Contributor

@rnc rnc commented Jan 27, 2025

@thescouser89 Idea being that when a release is run, the code section in the README is automatically updated with the most recent released version of the configuration. I've 'semi-tested' this ; I can't run a full test without doing a release.

<replacementType>file-contents</replacementType>
<fileMask>.md</fileMask>
<!-- Bit of hack as it is assuming this version is always 1.x -->
<findRegex>&lt;version&gt;1.*&lt;/version&gt;</findRegex>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not entirely happy with this but I think the only other way of doing it would be to remove any <version>[numeric]... from the readme that isn't for ide-config ; currently the only other instance is:

  <artifactId>spotless-maven-plugin</artifactId>
  <version>2.44.2</version>

Perhaps it would be better to move the above into a properties block so it simplifies the above regex? Thoughts?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant