Skip to content

ci: synchronize documentation pages on the tools.slack.dev site after changes #423

New issue

Have a question about this project? Sign up for a free account to open an issue and contact its maintainers and the community.

By clicking “Sign up for ”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on ? Sign in to your account

Merged
merged 6 commits into from
Apr 3, 2025

Conversation

lukegalbraithrussell
Copy link
Contributor

@lukegalbraithrussell lukegalbraithrussell commented Apr 2, 2025

Summary

This PR allows docs changes from this repo to be synced to the tools.slack.dev repo.

First, it syncs the changes and builds the entire docusaurus site with the changes.

If merged or workflow_dised, it then create a PR in the docs site repo

This should also work at a composite action in other repos methinks

Requirements (place an x in each [ ])

@zimegzimeg changed the title Feat docs sync workflow ci: synchronize documentation pages on the tools.slack.dev site after changes Apr 3, 2025
@zimegzimeg added docsImprovements or additions to documentation_actionsPull requests that update Actions codelabels Apr 3, 2025
@codecovCodecov
Copy link

codecov bot commented Apr 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.85%. Comparing base (79ad3a9) to head (38ecf51).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #423   +/-   ##
=======================================
  Coverage   99.85%   99.85%           
=======================================
  Files           7        7           
  Lines         702      702           
=======================================
  Hits          701      701           
  Misses          1        1           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Member

@zimeg zimeg left a comment

Choose a reason for hiding this comment

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

@lukegalbraithrussell This is a super exciting change! 📚 ✨

I'm approving now and left a few comments with small changes, but nothing blocking IMO if this works as expected.

We might want to wait for #422 to land or merge this beforehand to test that in completeness? I do not know. The next note is interesting to me before all:

The matrix isn't necessary but this allows it to match the format of the reverse workflow, which will be easier for future adjustments

👾

I'd be so curious if setting up a composite action might make maintenance somewhat better overall?

From what I can tell, most of these steps will be the same across repos with a few different inputs, and I'm hoping we could maintain and share that workflow from one repo instead.

Now might be a nice time to set that up if it seems like it'd be useful, but I'm not wanting to slow down improvement elsewhere 🚀

Copy link
Member

@zimeg zimeg left a comment

Choose a reason for hiding this comment

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

📝 The testing changes are super interesting but I'm leaving a comment that wonders if this should be left to the docs repo instead?

Otherwise this is exciting.

@lukegalbraithrusselllukegalbraithrussell merged commit d947f9a into main Apr 3, 2025
7 checks passed
@lukegalbraithrusselllukegalbraithrussell deleted the feat-docs-sync-workflow branch April 3, 2025 21:34
Sign up for free to join this conversation on . Already have an account? Sign in to comment
Labels
docsImprovements or additions to documentation_actionsPull requests that update Actions code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants