There is a utility GitHub action for diff-ing two release tags. This is intended to help answer the questions:
- What's changed since the last time I released?
- Do I need to re-index?
The utility takes a first and last release tag and generates a file with:
- A list of all the changes that were merged between those tags, including a brief description and the author.
- A recommendation about whether to re-index, based on whether any files that could affect indexing were changed.
This is a blunt instrument, and intended as a starting point only.
- For more information about any of the individual changes, contact the author.
- The re-indexing recommendation errs on the side of false positives. It will recommend re-indexing if any files that could affect the indexer changed, even if they wouldn't affect the result (e.g. adding a logging statement to an indexing job would trigger a recommendation to re-index).
- Open a web browser and navigate to the
Diff Releasesaction page. - Click the gray "Run Workflow" button on the left.
- Enter the first and last release tags in the text boxes and click the green "Run workflow" button below.
- Within a couple of minutes, you should see the workflow in progress.
- Once the workflow finishes, it should show a green checkmark. Click on the workflow run to see the results.
- The output file is linked in the "Artifacts" section. Click on the
diff-fileto download it.
- If the download is a ".zip" file, unzip it to get the ".txt" file inside.
- Open the output text file in a text editor on your local machine.
Running the script from the top-level directory will generate the output ".txt" file in your current working directory.
.github/tools/diffReleases.sh 0.0.365 0.0.370
ls -la diffReleases.txt