Skip to content

First Stable Release: v1.0#559

Merged
ormsbee merged 11 commits intomainfrom
kdmccormick/core-1
Apr 30, 2026
Merged

First Stable Release: v1.0#559
ormsbee merged 11 commits intomainfrom
kdmccormick/core-1

Conversation

@kdmccormick
Copy link
Copy Markdown
Member

@kdmccormick kdmccormick commented Apr 23, 2026

This removes the big warning messages about this package being unstable. We're happy for developers to begin using these APIs, except for the ones with big red "UNSTABLE" warnings in their docstrings.

Part of:

Blocks:

@kdmccormick kdmccormick changed the title Mark some APIs as Stable & Release v1.0 First Stable Release: v1.0 Apr 23, 2026
@kdmccormick kdmccormick requested review from bradenmacdonald and ormsbee and removed request for bradenmacdonald April 23, 2026 21:16

dependencies = [
('openedx_content', '0007_publishlogrecord_direct'),
migrations.swappable_dependency(settings.AUTH_USER_MODEL),
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Just a bit of clean-up. Claude added these, they don't need to be here.

@bradenmacdonald
Copy link
Copy Markdown
Contributor

bradenmacdonald commented Apr 24, 2026

Are there any function signatures or data classes we want to adjust now, before this goes out in Verawood?

@kdmccormick kdmccormick force-pushed the kdmccormick/core-1 branch 3 times, most recently from f6dbad2 to b955b92 Compare April 29, 2026 20:06
Comment thread README.rst
Each app exposes stable, public API of Python functions and Django models. Some apps additionally provides REST APIs. These APIs are suitable for use in ``openedx-platform`` as well as in community-developed Open edX plugins.
Each app exposes a public API of Python functions and Django models; some apps also provide REST APIs. These APIs are suitable for use in openedx-platform and in community-developed Open edX plugins.

APIs marked "UNSTABLE" are subject to change at any time. All other APIs are considered stable, and any breaking changes will be announced through the community DEPR (deprecation and removal) process.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

There are none now, but I'll leave this note here as a strategy we can use as we develop new APIs.

@kdmccormick kdmccormick marked this pull request as ready for review April 29, 2026 20:07
Copy link
Copy Markdown
Contributor

@bradenmacdonald bradenmacdonald left a comment

Choose a reason for hiding this comment

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

🚀

@ormsbee ormsbee force-pushed the kdmccormick/core-1 branch from e0fa70b to 39e8088 Compare April 30, 2026 04:27
@ormsbee ormsbee merged commit 6d074b9 into main Apr 30, 2026
6 checks passed
@ormsbee ormsbee deleted the kdmccormick/core-1 branch April 30, 2026 04:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants