swiftlang / swift-docc

Documentation compiler that produces rich API reference documentation and interactive tutorials for your Swift framework or package.
https://swift.org/documentation/docc
Apache License 2.0
1.17k stars 123 forks source link

Automate updating Github documentation page on swift-docc #392

Open Kyle-Ye opened 1 year ago

Kyle-Ye commented 1 year ago

Description

Outdated Github Page doc on swift-docc, swift-markdown and other swift-docc projects repo.

https://apple.github.io/swift-docc/documentation/swiftdocc/

https://apple.github.io/swift-markdown/documentation/markdown/

Although we add /bin/update-gh-pages-documentation-site script and the Github Deployment support. But it was triggered/deployed only once. While it should be trigered everytime a new PR is merged into main IMO.

image

This script should be run by someone with commit access to the 'gh-pages' branch at a regular frequency so that the documentation content on the GitHub Pages site is up-to-date with the content in this repo.

Checklist

Expected Behavior

Github deployment should be trigered everytime a new PR is merged into main.

Actual behavior

It was only trigger once manually by @ethan-kusters https://github.com/apple/swift-docc/commit/057215ba26a19cdcb02d7103f70acf21d465907b.

Steps To Reproduce

No response

Swift-DocC Version Information

No response

Swift Compiler Version Information

No response

Kyle-Ye commented 1 year ago

cc @ethan-kusters @franklinsch

Kyle-Ye commented 1 year ago

Assigned to @ethan-kusters as the owner and maintainer of update-gh-pages-documentation-site script file

ethan-kusters commented 1 year ago

@shahmishal is this something we could do in CI potentially?

Kyle-Ye commented 1 year ago

@shahmishal is this something we could do in CI potentially?

+1 for this. Maybe we can do it in Swift CI or via Github action

Kyle-Ye commented 1 year ago

@shahmishal is this something we could do in CI potentially?

Ping @shahmishal