Skip to content

January release notes for developer framework #151

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.

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 24 commits into from
Jan 27, 2024

Conversation

nrichers
Copy link
Collaborator

@nrichers nrichers commented Jan 22, 2024

Internal Notes for Reviewers

This PR includes:

  • January release notes for the developer framework
  • Updated copyright notice for 2024
  • Updated Makefile to generate test descriptions on the fly (looks like I'd missed this in Better test descriptions #144), plus quietened output
  • Refreshed notebooks and developer framework HTML docs
  • Updated the supported Python versions (and switched to a variable to make future updates easier)

Open items:

  • Looks like we might have a couple of new tests without release notes?

    image
  • [SC-8240] Add warning message for unregistered tests in template validmind-library#316 did a really nice job cleaning up our notebooks, but we need to figure out how to sweat more of the details. E.g. this new notebook that gets linked to from the release notes has some clearly unfinished stuff right at the top that both the original author and reviewer missed:

    image

Output

Capto_Capture 2024-01-24_01-52-20_pm

External Release Notes

@nrichers nrichers added the internal Not to be externalized in the release notes label Jan 22, 2024
@nrichers nrichers marked this pull request as draft January 22, 2024 04:33
@nrichers nrichers changed the title January release notes dev framework January release notes for developer framework Jan 22, 2024
@nrichers nrichers marked this pull request as ready for review January 22, 2024 06:09
@nrichers
Copy link
Collaborator Author

@mehdi0501 and @cachafla I have resolved your comments and updated the root comment with the latest output. Could you take another look and let me know if the release notes are ready? (We probably need to update the release date again but I will wait until the release notes are otherwise ready.)

Copy link
Contributor

@mehdi0501 mehdi0501 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look good to me, thank you for addressing the comments around explanations of the new dev framework features!

Copy link
Contributor

@cachafla cachafla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great 👏

@nrichers
Copy link
Collaborator Author

OK, updated the notebooks one last time and sanity checked that the rendered static site works as expected. Done, merging.

@nrichers nrichers merged commit 55c5dc9 into main Jan 27, 2024
@nrichers nrichers deleted the january-release-notes-dev-framework branch January 27, 2024 01:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal Not to be externalized in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants