-
Notifications
You must be signed in to change notification settings - Fork 24
ci: adds workflow for syncing docs out to docusaurus repo #29
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
ci: adds workflow for syncing docs out to docusaurus repo #29
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
license-eye has checked 592 files.
| Valid | Invalid | Ignored | Fixed |
|---|---|---|---|
| 462 | 1 | 129 | 0 |
Click to see the invalid file list
- sync-docs-from-cli-repo.yml
Use this command to fix any missing license headers
```bash
docker run -it --rm -v $(pwd):/github/workspace apache/skywalking-eyes header fix
</details>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #29 +/- ##
==========================================
+ Coverage 62.92% 62.94% +0.01%
==========================================
Files 210 210
Lines 22127 22127
==========================================
+ Hits 13924 13927 +3
+ Misses 7117 7114 -3
Partials 1086 1086 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| paths: | ||
| - "docs/**" | ||
| pull_request: | ||
| branches: | ||
| - main | ||
| paths: | ||
| - "docs/**" | ||
| workflow_dispatch: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the if statement below means it only creates the PR on push and dispatch. but it'll run everything else as a test for PRs made
zimeg
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sweet PR for keeping all things up to date 📚 ✨
All of this looks good to me and the cases this runs for are solid too. I think this is good to merge but left one comment on the last step that is no blocker.
I look forward to the reusable workflow as well but am also so excited for a syncing workflow. It's neat stuff 🤖
|
|
||
| - name: Output the pull request link | ||
| if: ${{ steps.site-pr.outputs.pull-request-url }} | ||
| run: | | ||
| echo "Pull request created: ${{ steps.site-pr.outputs.pull-request-url }}" >> $GITHUB_STEP_SUMMARY No newline at end of file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - name: Output the pull request link | |
| if: ${{ steps.site-pr.outputs.pull-request-url }} | |
| run: | | |
| echo "Pull request created: ${{ steps.site-pr.outputs.pull-request-url }}" >> $GITHUB_STEP_SUMMARY |
Quick note since this is useful to have, but IIRC this step was added for collecting links of various PRs made to multiple separate repos at a time - often for sample apps.
Here we target a single source of truth and this might not be as needed, but of course no need to change it! This is a note 👾
Summary
This adds a workflow that takes edits to the md docs in this repo and pushes it to the docusaurus build. This will be using a reusable workflow soon, and i'll replace this then.
Requirements