-
Notifications
You must be signed in to change notification settings - Fork 1.1k
chore: Making automated version updates in readme.md #9150
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
Conversation
generation/readme_update.sh
Outdated
for module in $(find . -mindepth 2 -maxdepth 2 -name pom.xml | sort | xargs dirname); do | ||
|
||
if [[ "${module}" = *java-core ]] || [[ "${module}" = *java-shared-dependencies ]] || [[ "${module}" = *java-iam ]]; then | ||
continue |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Indent file.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
generation/readme_update.sh
Outdated
|
||
readme_file="${module}/README.md" | ||
|
||
if [ -e ${module}/README.md ]; then |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Indent file.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
generation/readme_update.sh
Outdated
@@ -0,0 +1,38 @@ | |||
#!/bin/bash | |||
|
|||
config_line="" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, removed now.
generation/readme_update.sh
Outdated
|
||
for module in $(find . -mindepth 2 -maxdepth 2 -name pom.xml | sort | xargs dirname); do | ||
|
||
if [[ "${module}" = *java-core ]] || [[ "${module}" = *java-shared-dependencies ]] || [[ "${module}" = *java-iam ]]; then |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should java-iam be excluded? If so, can you add source code comment why?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think it should have been excluded. I've added it back again, along with necessary changes in its readme.
generation/readme_update.sh
Outdated
line_number_end=$(grep -n -m 1 "Scala" ${readme_file} | sed 's/\([0-9]*\).*/\1/') | ||
end_line=${line_number_end}+4 | ||
|
||
start_line_append="<!--- {x-version-update-start:${artifactId}:released} -->" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
start_line_append="<!--- {x-version-update-start:${artifactId}:released} -->" | |
start_line_append="<!-- {x-version-update-start:${artifactId}:released} -->" |
I believe it's unnecessary.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah, it works either way.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, it works but unnecessary. Let's not to have unnecessary characters.
This PR does 2 things:
readme_update.sh
script which is responsible for adding annotations in all the valid readme.md files.Later on I will introduce how to use libraries-bom in all the readme's, along with automated version updates for it.