Documentation Workgroup meeting: September 23rd, 2024

Swift Documentation Workgroup Updates
1

The Documentation Workgroup will be holding its next meeting on Monday, September 23rd, 2024 from 8:00am to 9:00am PT (or see the time in your own timezone).

This meeting will be open to anyone who wishes to contribute. If you wish to participate, please reach out to @swift-documentation-workgroup in forums via DM for a link to the WebEx meeting.

Meeting notes for this meeting will posted in this thread shortly after.

Meeting notes

  • GitHub CI and swift-testing (@Kyle-Ye)

Please propose additional agenda items in this thread.

1 Like
2

Meeting notes

  • (Kyle) Is it okay to add GitHub Actions to swift-docc repos? NIO has some repos with GitHub actions

  • (Vera) Would be nice, requires admin permissions. Would probably want to go straight to Mishal Shah.

  • (David) It would be nice to use GitHub Actions to create pipelines for older Swift versions.

  • (Franklin) Could keep Swift CI and GitHub Actions running in parallel for some time.

  • (Vera) Will take action item to reach out to relevant folks who have admin access.

  • (Rauhul) Would be good to sync with Franz and Mishal. Does not support macros yet.

  • (Franklin) Is there a cost to the GitHub Actions that NIO uses?

  • (Rauhul) They run in AWS for Linux.

  • (Dianna) GitHub Actions doesn't support Swift 6 on macOS yet.

  • (David) Should be fine because that's covered by Swift CI.

  • (Vera) Right, primary purpose would be to test historical versions.

  • (Rauhul) Since DocC is part of the toolchain, probably still need Swift CI.

  • (Kyle) Can we add swift-testing to swift-markdown? There shouldn't be circular dependency issues since Testing is in the toolchain now.

  • (Kyle) What is the migration path?

  • (David) Hinges on how important it is to run tests against older toolchains.

  • (Kyle) Right, older macOS doesn't have Testing in the SDK.

  • (Vera) Makes it more difficult to maintain a minimum version.

  • (Kyle) Maybe we need to wait until we've bumped swift-markdown's minimum version to Swift 6.

  • (Vera) That would be the safest option, but we'll be waiting at least a year for that.

  • (Kyle) Maybe we should enquire about backwards compatibility rather than bumping the minimum version.

  • (David) There may be cases where we can write certain new tests if we don't have any reason to believe that the behavior will be different on older toolchains.

3

As a follow-up (I suspect folks may already know) - Mishal created a new repository in swiftlang (GitHub - swiftlang/github-workflows) that is hosting a number of workflow components for common use across the swiftlang org's repositories.

It looks like that's just getting established and issues ironed out for general applicability, and is heading to where we could apply it to swift-docc for some of the explicit regression testing needs @Kyle-Ye was inquiring about and advocating for.

1 Like