rocksdb/unreleased_history/add.sh

41 lines
1.2 KiB
Bash
Raw Normal View History

#! /usr/bin/env bash
# Copyright (c) Meta Platforms, Inc. and affiliates.
set -e
set -o pipefail
cat << EOF
Release note advice:
* Speak to the RocksDB user and what is impacted in the public API
Formatting with markdown:
* This is an example list item referring to \`BlockBasedTableOptions\`.
If not starting with "* " it will be inserted at release time. This is OK.
*This asterisk begins italics, NOT a list item. PROBABLY WRONG
EOF
if [ "$1" ]; then
echo "Press return to continue"
read
# Target file specified on command line
TARGET="$1"
else
# Interactively choose a group and file name
DIRS="`find unreleased_history/ -mindepth 1 -maxdepth 1 -type d`"
echo "Choose a group for new release note:"
echo "$DIRS" | grep -nEo '[^/]+$'
echo -n "Enter a number: "
while [ ! "$DIRNUM" ]; do read -r DIRNUM; done
DIR="$(echo "$DIRS" | head -n "$DIRNUM" | tail -1)"
echo "Choose a file name for new release note (e.g. improved_whatever.md):"
while [ ! "$FNAME" ]; do read -re FNAME; done
# Replace spaces with underscores
TARGET="$(echo "$DIR/$FNAME" | tr ' ' '_')"
fi
# Edit/create the file
${EDITOR:-nano} "$TARGET"
# Add to version control (easy to forget!)
git add "$TARGET"