Update CHANGELOG.md #166
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,59 @@ | ||
| # queryservice | ||
|
|
||
| ## 0.3.135-wbstack.8 - April 10, 2026 | ||
| - Merge all of the GitHub Action Dependabot updates | ||
| - Bump actions/cache from 4 to 5 (#152) | ||
| - Bump actions/checkout from 4.1.5 to 6.0.2 (#153) | ||
| - Bump actions/github-script from 7 to 8 (#158) | ||
| - Bump hadolint/hadolint-action from 3.1.0 to 3.3.0 (#159) | ||
| - Bump docker/setup-qemu-action from 3.0.0 to 4.0.0 (#161) | ||
| - Bump docker/setup-buildx-action from 3.3.0 to 4.0.0 (#162) | ||
| - Bump docker/build-push-action from 5.3.0 to 7.0.0 (#163) | ||
| - Bump docker/metadata-action from 5.5.1 to 6.0.0 (#164) | ||
| - Bump docker/login-action from 3.1.0 to 4.1.0 (#165) | ||
|
|
||
| ## 0.3.135-wbstack.7 - Jun 18, 2025 | ||
| - add User-Agent env var (#150) | ||
|
|
||
| ## 0.3.135-wbstack.6 - Oct 24, 2024 | ||
| - Add allowlist at container runtime (#149) | ||
|
|
||
| ## 0.3.135-wbstack.5 - Sep 23, 2024 | ||
| - Update allowlist.txt to include wikibase cloud wikis (#148) | ||
|
|
||
| - Also update the static list from the Wikidata queryservice | ||
|
|
||
| ## 0.3.135-wbstack.4 - Apr 24, 2024 | ||
| - Merge pull request #122 from wbstack/tarrow-patch-1 | ||
|
|
||
| - gh-actions: move to docker/metadata-action | ||
|
|
||
| ## 0.3.135-wbstack.3 - Apr 18, 2024 | ||
| - Merge pull request #113 from egonw/patch-1 | ||
|
|
||
| - Updated the URL of the WikiPathways SPARQL endpoint | ||
|
|
||
| ## 0.3.135-wbstack.2 - Apr 17, 2024 | ||
| - fix: whitelist.txt is superseded by allowlist.txt (#111) | ||
|
|
||
| ## 0.3.137-wbstack.1 - Apr 16, 2024 | ||
|
Member
There was a problem hiding this comment. How come this is
Author
There was a problem hiding this comment. it's from 2024... I don't know what decision was made here? :(
Author
There was a problem hiding this comment. check this out: https://github.com/wbstack/queryservice/tags
Member
There was a problem hiding this comment.
I believe it is within your capabilities to find it out.
Which part specifically would you like me to check out? That is just a page of tags and the commit message of the referenced commit. What conclusion have you drawn by looking at that page? Please find out the reason why this is the only |
||
| - chore: update base image to wmde.20 (#109) | ||
|
|
||
| ## 0.3.135-wbstack.1 - Apr 4, 2024 | ||
| - chore: update base image to latest version known to work with mw 1.39 (#108) | ||
|
|
||
| ## November 2020 | ||
| - 0.3.6_0.6- From Github Build... | ||
|
|
||
| ## April 2020 | ||
| - 0.3.6-0.5 - whitelist https://sparql.rhea-db.org/sparql for Andra | ||
| - 0.3.6-0.4 - whitelist https://sparql.nextprot.org/ for Andra | ||
| - 0.3.6-0.3 - More and custom whitelist | ||
|
|
||
| ## November 2019 | ||
| - 0.3.6-0.2 - Includes lod.openaire.eu in whitelist | ||
| - 0.3.6-0.1 - First version fo 0.3.6 | ||
|
|
||
| ## October 2019 | ||
| - 0.10 - Wednesday before Wikidatacon | ||
| - 0.1 - Initial version. wdqs 0.3.1 | ||
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.
This and the other merge commit aren't very useful information in the changelog. The changelog shouldn't be a copy of the git history, that already exists for people to look at if they want. This should be a more useful human-readable update about what has changed in each new release.
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 just copied them from the release logs :( and it's a year old
Uh oh!
There was an error while loading. Please reload this page.
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 looked into this some more, and we don't actually have any releases (see https://github.com/wbstack/queryservice/releases). We only have tagged commits (see https://github.com/wbstack/queryservice/tags). Is this what you meant by "release log"?
The text you see with each tag in the GitHub interface isn't a release note; it is the commit message of the commit the tag is referencing. It only contains that one commit message; not, for example, all the commit messages since the last tag.
For instance the text you see with the
0.3.135-wbstack.3tag is:However, looking at the git history we can see there was more than just that commit since the last tag:
The same is true of the
0.3.135-wbstack.5,0.3.135-wbstack.4,0.3.135-wbstack.2, and0.3.135-wbstack.1tags.IMO a changelog (or release notes) should be providing a useful, human-readable, summary of the changes that have happened since the last change/release/tag and, if necessary, highlighting any breaking changes. Otherwise, the changelog is not providing any more value than the git history and there isn't much point in having one.
Providing only the last commit for each tag in the changelog is likely worse than not having a changelog as it gives readers a false understanding of the changes that have happened.
Looking at #113 we can see that all the useful information about this change ("Updated the URL of the WikiPathways SPARQL endpoint") is included in the changelog. The "Merge pull request #113 from egonw/patch-1" line provides little useful information to the reader. Please remove these merge commit lines from the changelog.
I don't find this a valid rationale.
Hopefully I have provided you with a good explanation of why this isn't sufficient and what I am expecting from a changelog. If anything is unclear, you would like further explanation, or you're unsure how to proceed, please ask for some guidance.
The git history doesn't get deleted after a year. You are a developer, you are able to analyse a git repo to figure out what code changes that have happened. The commit messages and linked tasks should provide why they happened (granted our commit messages in the past haven't been very good which can make things harder; we should also strive to improve in this area, at least for the commits that end up on the
mainbranch).