File tree 2 files changed +14
-2
lines changed
2 files changed +14
-2
lines changed Original file line number Diff line number Diff line change 2
2
3
3
This is developer documentation to help with release notes. It is not published in our docs guide.
4
4
5
+ ## Requirements
6
+ - This script assumes you're running a Bash shell.
7
+ - Install [ DuckDB] ( https://duckdb.org/#quickinstall ) .
8
+ - On Macs, the easiest way to do this is via [ Homebrew] ( https://brew.sh/ ) : ` brew install duckdb ` .
9
+ - Install the [ GitHub CLI] ( https://cli.github.com/ ) .
10
+ - On Macs, the easiest way to do this is via [ Homebrew] ( https://brew.sh/ ) : ` brew install gh ` .
11
+ - If you're on a Mac, you also need to:
12
+ - Install the GNU date library and alias it to the ` date ` command: ` brew install coreutils ; echo "alias date=gdate" >> ~/.bash_profile `
13
+
5
14
## How to generate release notes
6
15
7
16
1 . Run the ` find_missing_prs.sh ` script, passing the release version number as the only argument.
Original file line number Diff line number Diff line change 1
1
#! /usr/bin/env bash
2
2
3
+ shopt -s expand_aliases
4
+ source ~ /.bash_profile
5
+
3
6
function print_help {
4
7
cat << EOF
5
8
Usage: $( basename $0 ) <VERSION_NUMBER>
@@ -44,7 +47,7 @@ TEMPLATE_FILE=TEMPLATE.md
44
47
# If the notes file doesn't yet exist, create one
45
48
if [ ! -f $NOTES_FILE ]; then
46
49
cp $TEMPLATE_FILE $NOTES_FILE
47
- sed -i " s/__VERSION__/$RELEASE /g" $NOTES_FILE
50
+ sed -i ' ' " s/__VERSION__/$RELEASE /g" $NOTES_FILE
48
51
fi
49
52
50
53
PREV_NOTES_FILE=$( ls -1 | sort | grep -B 1 $NOTES_FILE | head -n 1)
@@ -95,7 +98,7 @@ gh pr list \
95
98
96
99
# Find and cache the URLs to any PRs that we've already referenced in the
97
100
# release notes.
98
- grep -Po ' https://github\.com/mathesar-foundation/mathesar/pull/\d*' \
101
+ grep -o ' https://github\.com/mathesar-foundation/mathesar/pull/\d*' \
99
102
$NOTES_FILE > $INCLUDED_PRS_FILE
100
103
101
104
# Generate a CSV containing details for PRs that match commits in the release
You can’t perform that action at this time.
0 commit comments