Skip to content

Latest commit

 

History

History
60 lines (36 loc) · 2.31 KB

README.md

File metadata and controls

60 lines (36 loc) · 2.31 KB
Raw

PR Summary Scripts

This repository contains scripts to generate a merged PR summary and create a specific blog post. These scripts can be used to build change logs for releases and create blog posts for specific updates.

Scripts

The following scripts are included in this repository:

  • scripts/download-prs.sh
  • scripts/distribute-merged-prs.sh
  • scripts/summarise-merged-prs.sh
  • scripts/create-slug.sh

Usage

PR Summary Scripts

To use these scripts, follow the instructions below:

  1. Run the download-prs.sh script by executing the following command:
./scripts/download-prs.sh input-output-hk/cardano-node

This script will download the PRs that were merged between two specified dates and . Please note that the end date is exclusive.

  1. Execute the distribute-merged-prs.sh script using the following command:
./scripts/distribute-merged-prs.sh input-output-hk/cardano-node $dir 2022-06-25 2023-04-18

This script will distribute the downloaded PRs based on the files they have touched in the the directory $dir.

  1. Finally, run the summarise-merged-prs.sh script by executing the following command:
./scripts/summarise-merged-prs.sh input-output-hk/cardano-node v8.0.0

This script will create summaries that can be directly pasted into change logs.

Update creation script

Execute the create-slug.sh script with the following command:

./create-slug.sh <author> <date> <end_date>

This script will create a markdown file named blog/-node-cli-api.md, authored by "", with sections for updates from "" to "<end_date>". It automatically runs the PR summary scripts as defined above so you can cherry pick the PRs as necessary.

Additional Information

  • The download process may be slow, so it is beneficial to use the other scripts to automate the download.
  • Manual intervention is required between the distribution and summarization stages. This step allows for detailed edits, such as removing irrelevant PRs, from the summary. The detail section of the summary includes a file list, making it easier to assess the relevance of each PR to the component.

For an example of the output produced by each script, refer to the example commit on the official GitHub repository.