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

Automate updating Github documentation page on swift-docc #392

Open
2 tasks done
Kyle-Ye opened this issue Sep 26, 2022 · 5 comments
Open
2 tasks done

Automate updating Github documentation page on swift-docc #392

Kyle-Ye opened this issue Sep 26, 2022 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Kyle-Ye
Copy link
Collaborator

Kyle-Ye commented Sep 26, 2022

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

@Kyle-Ye Kyle-Ye added bug Something isn't working documentation Improvements or additions to documentation and removed bug Something isn't working labels Sep 26, 2022
@Kyle-Ye
Copy link
Collaborator Author

Kyle-Ye commented Sep 26, 2022

cc @ethan-kusters @franklinsch

@Kyle-Ye
Copy link
Collaborator Author

Kyle-Ye commented Sep 30, 2022

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

@ethan-kusters
Copy link
Contributor

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

@Kyle-Ye
Copy link
Collaborator Author

Kyle-Ye commented Oct 1, 2022

@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
Copy link
Collaborator Author

Kyle-Ye commented Nov 3, 2022

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

Ping @shahmishal

@d-ronnqvist d-ronnqvist changed the title Outdated Github page on swift-docc Automate updating Github documentation page on swift-docc Dec 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants