Skip to content

Add a CI job for SDoc #1331

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

Open
kou opened this issue Mar 25, 2025 · 2 comments
Open

Add a CI job for SDoc #1331

kou opened this issue Mar 25, 2025 · 2 comments

Comments

@kou
Copy link
Member

kou commented Mar 25, 2025

It'll prevent introducing breaking changes for SDoc.

See also: #1304 (comment)

@st0012
Copy link
Member

st0012 commented Mar 25, 2025

I understand the reasoning but I'm not sure if it's a good solution.

sdoc (and some other projects using rdoc) have various levels of patches on rdoc. If we need to avoid breaking them, it'll dramatically limit our ability to improve rdoc's codebase. For example, I think we should do #1309 even if it breaks sdoc as Store should be considered private.

And even if we think changes like #1309 is breaking and will release it with a major version bump, it'd still break the job nonetheless until 1) we cut the release, and 2) sdoc adopts the version and update its codebase for it. And before both of those happens we'd just have a broken CI.

Sure, we may say it'd be an optional job that's allowed to be broken. But from my experience those jobs will always be ignored and removed after a while as the value of maintaining it is low.

@st0012
Copy link
Member

st0012 commented Mar 25, 2025

A more common, and maybe effective approach, would be for sdoc to run CI against the latest rdoc and provide feedback close to when the changes are merged.
Things could still break, but ideally we'll catch and improve most of them before releases.

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

No branches or pull requests

2 participants