Skip to content

Commit

Permalink
Add script to generate release checklist issue text (#237)
Browse files Browse the repository at this point in the history
* Add script for generating the release checklist

* Add note about script
  • Loading branch information
jacobtomlinson authored Jun 12, 2023
1 parent 5d1fa0e commit 4864ef6
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions scripts/gen_release_checklist_issue.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
#!/bin/bash
# Run this script to generate the release issue checklist for easy pasting into GitHub

SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
SCRIPT_NAME=$(basename $SCRIPT_DIR)/$(basename "${BASH_SOURCE[0]}")
cd $SCRIPT_DIR/..

cat << EOF
# Release checklist
For the upcoming release we need to verify our documentation. This is a best efforts activity
so please refer to the checklist from the previous release and focus on pages that were not
verified last time.
## Verify pages
- Look at the nightly build of each page listed below
- Check page renders correctly
- Check for spelling/grammar problems
- Check that the instructions work as expected
- Ensure legacy pages with out of date instructions have a content warning
- If page needs updating convert the task to an issue and open a PR that closes the issue
\`\`\`[tasklist]
### Pages
EOF

find source -type f -name "*.ipynb" -o -name "*.md" \
| grep -v "_includes" \
| sed -e "s/^source/- [ ] https\:\/\/docs.rapids.ai\/deployment\/nightly/" \
| sed -e "s/index.md//" \
| sed -e "s/.md/\//"\
| sed -e "s/.ipynb/\//" \
| sort -u

cat << EOF
\`\`\`
_Issue text generated by \`${SCRIPT_NAME#./}\`._
EOF

0 comments on commit 4864ef6

Please sign in to comment.