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
Fix README.txt for release packages #1916
Conversation
Thanks @Wengier, the end result is good. The docs/README.template (We've even parameterized the REPO, so this file is properly created in forks). The PR's approach of adding a new release-only README and flip-flopping: doesn't make use of the template, which can be expanded with the improved wording in your new README, plus new field(s) to indicate if it's a release tag (or a development build). Ideally we want the template fed from as much repo metadata as possible. |
Regarding determining if the currently checkout is a release or not, I think that logic should be moved into the package creation script or a stand-alone script. The PR does this using three duplicate and not-obvious shell lines in the CI code: The triple duplication needs to be collapsed and made more self-documenting, and be moved locally so it's as portable as the current package-creation script, which can be run locally (without needing CI). |
Regarding determining if the commit is a release or not:
The Something like this can describe the type of commit: function describe_commit() {
if version_tag=$(git describe --exact-match HEAD 2> /dev/null); then
echo "release $version_tag"
else
echo "a development branch"
fi
} That could be put into a bash script or function and made a bit more self documenting: commit_description=$(describe_commit) This 'release vs. dev branch' aspect can be added to the README template, perhaps with something like:
Which could be populated along with the other template population steps the package creation script currently performs, with something like: sed -i -e "s|%COMMIT_DESCRIPTION%|$commit_description|" "$readme_tmpl" |
Regarding the PR's addition of a |
ddd1bfc
to
e38259c
Compare
e38259c
to
97bc984
Compare
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.
Thanks @Wengier.
Just one comment regarding use of export
.
97bc984
to
55a72c0
Compare
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.
Looks good!
I have noticed that all current packages including the release zip packages contain file README/README.TXT which claims they are development snapshot builds with some technical info. This PR adds a new README/README.TXT file as a brief introduction to the project for inclusion with the release packages (with tags like refs/tags/v0.79.0) instead of the file for development snapshot builds.