Skip to content
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

CI: sync API docs with readme.com #266

Merged
merged 24 commits into from
Feb 9, 2024
Merged

CI: sync API docs with readme.com #266

merged 24 commits into from
Feb 9, 2024

Conversation

masci
Copy link
Contributor

@masci masci commented Jan 25, 2024

When changes to integrations/* are merged on main:

Note for the reviewer:

@masci masci force-pushed the massi/readme-sync branch 3 times, most recently from f4276e9 to 00cee9a Compare January 25, 2024 18:13
@masci masci force-pushed the massi/readme-sync branch from aa15438 to 2d1b7c1 Compare January 26, 2024 11:29
@masci masci marked this pull request as ready for review January 26, 2024 11:41
@masci masci requested a review from a team as a code owner January 26, 2024 11:41
@masci masci requested review from shadeMe and removed request for a team January 26, 2024 11:41
Copy link
Contributor

@shadeMe shadeMe left a comment

Choose a reason for hiding this comment

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

LGTM! The suggestion's optional. Feel free to merge (or not).

If we merge this workflow, it would fail for integration that don't support hatch run docs yet. Not sure if we should wait, let it fail, or add safeguards to skip the job when hatch run docs is not available

Just a thought: A probable outcome of skipping the job will be our procrastinating adding support for hatch in those integrations 😄 If it's not a lot of work, we might want to prioritize it.

.github/workflows/CI_readme_sync.yml Outdated Show resolved Hide resolved
@masci
Copy link
Contributor Author

masci commented Feb 6, 2024

Do not merge until #274 is complete

@masci masci force-pushed the massi/readme-sync branch from 74eed06 to a8d8964 Compare February 9, 2024 11:24
@masci masci merged commit e49d52d into main Feb 9, 2024
3 checks passed
@masci masci deleted the massi/readme-sync branch February 9, 2024 11:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment