Skip to content

Unified CI workflow #618

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 5 commits into from
Mar 12, 2025
Merged

Unified CI workflow #618

merged 5 commits into from
Mar 12, 2025

Conversation

ladvoc
Copy link
Contributor

@ladvoc ladvoc commented Mar 6, 2025

This PR creates a unified CI workflow that performs building, testing, linting, and documentation generation. This brings several advantages:

  • Multi-platform docs: previously, docs were built only for macOS—meaning any platform-specific symbols would not be included in the built documentation. Moving to a unified CI workflow allows generating symbol graphs across multiple platforms to be used in doc generation without redundant builds.
    • In the platform matrix, any platform that has symbol-graph set to true will trigger a release build with symbol graphs emitted—these will then be used to build docs.
  • Doc correctness: warnings generated by DocC should be visible before PRs are merged to main.
  • Single run: only one workflow run is triggered per push.

ladvoc added 2 commits March 6, 2025 08:46
- Create single workflow for building, testing, linting, and doc generation
- Update publish docs workflow to use pre-built docs
- Create empty documentation catalog
Copy link

ilo-nanpa bot commented Mar 6, 2025

it seems like you haven't added any nanpa changeset files to this PR.

if this pull request includes changes to code, make sure to add a changeset, by writing a file to .nanpa/<unique-name>.kdl:

minor type="added" "Introduce frobnication algorithm"

refer to the manpage for more information.

@ladvoc ladvoc mentioned this pull request Mar 6, 2025
cancel-in-progress: true

env:
TESTS: "FunctionTests SDKTests RoomTests PublishDataTests PublishBufferCapturerTests VideoViewTests TrackTests"
Copy link
Contributor

Choose a reason for hiding this comment

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

is this really necessary? seems like an easy trap that we'll add new tests but forget to add them here and thus CI won't actually run them

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This part was copied from the existing test workflow.

Copy link
Member

Choose a reason for hiding this comment

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

Yes Ben is right, but some tests don't run on CI/Simulator needs device etc. We can organize this in another PR.

When run for PRs, ref name can contain "/" which is not file path safe.
@ladvoc ladvoc merged commit 969cfdf into livekit:main Mar 12, 2025
14 of 17 checks passed
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