Skip to content

Merge main into staging #612

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 30, 2024
Merged

Merge main into staging #612

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
70a3e4e
Cleanup of 2024 releases + new cleanup notebook/script (#610)
validbeck Dec 30, 2024
cff506e
Merge remote-tracking branch 'origin/main' into staging
github-actions[bot] Dec 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions internal/templates/yearly-releases.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
# TITLE-MARKER
title: "0000 Releases"
date: last-modified
# REMOVE THIS `FALSE` FLAG AFTER YEARLY RELEASES HAVE ALL BEEN GATHERED ONTO THIS LANDING
search: false
listing:
# LISTING-MARKER
- id: 0000-releases
type: grid
max-description-length: 250
sort: false
fields: [title, description]
contents:
# RELEASE-FILES-MARKER
---

<!-- EMBED-MARKER -->
:::{#0000-releases}
:::
63 changes: 37 additions & 26 deletions release-scripts/generate-release-notes.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"\n",
"Release information is extracted from the release tags, and then sorted by label. Then, we put the information through OpenAI for preliminary editing. \n",
"\n",
"After running the notebook, you'll see new generated release notes added to the `~/site/releases` folder for you to clean up further, along with a live preview of the site generated by the notebook to get you started."
"After running the notebook, you can locate the new generated release notes added to the `~/site/releases` folder for you to clean up further, along with a live preview of the site to get you started."
]
},
{
Expand All @@ -31,8 +31,8 @@
" - [Collect GitHub URLs](#toc2_4_) \n",
" - [Set the release date](#toc2_5_) \n",
"- [Extracting PR information](#toc3_) \n",
" - [Create release folder](#toc3_1_) \n",
" - [Create the release notes file](#toc3_2_) \n",
" - [Create release folder and file](#toc3_1_) \n",
" - [Add the date to release notes ](#toc3_2_) \n",
" - [Set up release notes components](#toc3_3_) \n",
" - [Set the repository and tag name](#toc3_4_) \n",
" - [Extract PRs from each URL](#toc3_5_) \n",
Expand All @@ -48,9 +48,10 @@
" - [Write release notes to file](#toc5_1_) \n",
" - [Update sidebar](#toc5_2_) \n",
" - [Update index](#toc5_3_) \n",
" - [Show files to commit](#toc5_4_) \n",
" - [Preview release notes](#toc5_5_) \n",
"- [Next steps](#toc6_) \n",
" - [Show files to commit](#toc6_1_) \n",
" - [Preview release notes](#toc6_2_) \n",
" - [Wrap it up](#toc6_2_) \n",
"\n",
"<!-- vscode-jupyter-toc-config\n",
"\tnumbering=false\n",
Expand Down Expand Up @@ -103,7 +104,7 @@
},
{
"cell_type": "code",
"execution_count": null,
"execution_count": 1,
"metadata": {},
"outputs": [],
"source": [
Expand Down Expand Up @@ -177,7 +178,8 @@
"metadata": {},
"outputs": [],
"source": [
"gro.github_urls = gro.collect_github_urls() "
"gro.github_urls = gro.collect_github_urls() \n",
"gro.count_repos(gro.github_urls)"
]
},
{
Expand Down Expand Up @@ -218,11 +220,11 @@
"source": [
"<a id='toc3_1_'></a>\n",
"\n",
"### Create release folder \n",
"### Create release folder and file\n",
"\n",
"These lines will create a folder inside of `~/site/releases` for the release notes. \n",
"These lines will create a folder inside of `~/site/releases` for the release notes with a new `release-notes.qmd` file. The folder name is the release date, as per our convention. \n",
"\n",
"The folder name is the release date, as per our convention."
"**If the directory and file already exists, you will be prompted to confirm whether or not you want to overwrite the contents.**"
]
},
{
Expand All @@ -240,7 +242,7 @@
"source": [
"<a id='toc3_2_'></a>\n",
"\n",
"### Create the release notes file \n",
"### Add the date to release notes \n",
"This block writes the specified date as the title of the new release notes file."
]
},
Expand Down Expand Up @@ -589,11 +591,20 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"<a id='toc5_4_'></a>\n",
"<a id='toc6_'></a>\n",
"\n",
"## Next steps "
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"<a id='toc6_1_'></a>\n",
"\n",
"### Show files to commit \n",
"\n",
"This block shows you the files changed or added you need to commit — it should omit any files in `release-scripts/`. "
"This block shows you the files changed or added by the notebook you need to commit — it should omit any files in `release-scripts/`. "
]
},
{
Expand All @@ -602,14 +613,16 @@
"metadata": {},
"outputs": [],
"source": [
"gro.show_files()"
"%%bash\n",
"cd ../\n",
"git status | grep -v 'release-scripts/'"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"<a id='toc5_5_'></a>\n",
"<a id='toc6_2_'></a>\n",
"\n",
"### Preview release notes \n",
"Run this cell to preview the site, including the new release notes you just generated. "
Expand All @@ -632,26 +645,24 @@
"source": [
"<div class=\"alert alert-block alert-info\" style=\"background-color: #B5B5B510; color: black; border: 1px solid #083E44; border-left-width: 5px; box-shadow: 2px 2px 4px rgba(0, 0, 0, 0.2);border-radius: 5px;\"><span style=\"color: #083E44;\"><b>When you're done with the preview, please restart the kernel.</b></span>\n",
"<br></br>\n",
"Make sure that when you commit your changes to remote, do NOT include the changes in the <code>internal/release-scripts/</code> folder as that would commit changed notebook with the output cells.</div>"
"Make sure that when you commit your changes to remote, do NOT include the changes in the <code>~/release-scripts/</code> folder as that would commit changed notebook with the output cells.</div>"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"<a id='toc6_'></a>\n",
"<a id='toc6_3_'></a>\n",
"\n",
"## Next steps "
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Wrap it up\n",
"\n",
"Edit the new release notes in accordance with our [internal guide](https://www.notion.so/validmind/Create-Release-Notes-c4291bb92f644c5eb490cc21a8a79ca5?pvs=4) to make sure you've completed all the requirements.\n",
"**You may want to send a commit up to remote before you begin editing so you have a backup.**\n",
"\n",
"**You may want to send a commit up to remote before you begin editing so you have a backup.**"
"- [ ] At the end of the release notes file, make sure that the notebook appended the `_how-to_upgrade.qmd` include to the very bottom.\n",
"- [ ] Make sure that the link to the new release notes displays as expected in the sidebar under `About > Releases`. \n",
"- [ ] Double-check that the `Latest Releases` section on our main documentation landing page includes the new release and looks uniform.\n",
"- [ ] Edit the new release notes in accordance with our [internal guide](https://www.notion.so/validmind/Create-Release-Notes-c4291bb92f644c5eb490cc21a8a79ca5?pvs=4) to make sure you've completed all the requirements.\n",
"- [ ] Make sure any relevant files are committed to remote in preparation for your PR!\n"
]
}
],
Expand Down
Loading