Skip to content

Conversation

@lukegalbraithrussell
Copy link
Contributor

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

@lukegalbraithrussell lukegalbraithrussell requested a review from a team as a code owner April 10, 2025 21:40
Copy link
Contributor

@github-actions github-actions bot left a 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
Copy link

codecov bot commented Apr 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 62.94%. Comparing base (f2a26f0) to head (5740366).
Report is 1 commits behind head on main.

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.
📢 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.

@lukegalbraithrussell lukegalbraithrussell self-assigned this Apr 10, 2025
@lukegalbraithrussell lukegalbraithrussell added the docs M-T: Documentation work only label Apr 10, 2025
Comment on lines +3 to +14
on:
push:
branches:
- main
paths:
- "docs/**"
pull_request:
branches:
- main
paths:
- "docs/**"
workflow_dispatch:
Copy link
Contributor Author

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

@slackapi slackapi deleted a comment from github-actions bot Apr 10, 2025
@mwbrooks mwbrooks added the semver:patch Use on pull requests to describe the release version increment label Apr 10, 2025
@mwbrooks mwbrooks added this to the Next Release milestone Apr 10, 2025
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.

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 🤖

Comment on lines +70 to +74

- 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
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- 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 👾

@lukegalbraithrussell lukegalbraithrussell merged commit 034ae57 into main Apr 10, 2025
6 checks passed
@lukegalbraithrussell lukegalbraithrussell deleted the docs-ci-sync-docs-from-cli-repo-workflow branch April 10, 2025 22:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs M-T: Documentation work only semver:patch Use on pull requests to describe the release version increment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants