Skip to content

Automate updating Github documentation page on swift-docc #392

Open
@Kyle-Ye

Description

@Kyle-Ye

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

  • If possible, I've reproduced the issue using the main branch of this package.
  • This issue hasn't been addressed in an existing GitHub issue.

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 057215b.

Steps To Reproduce

No response

Swift-DocC Version Information

No response

Swift Compiler Version Information

No response

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions