feature(workflow): added Kmeshctl doc syncing workflow by yashisrani · Pull Request #1498 · kmesh-net/kmesh

yashisrani · 2025-09-04T17:02:48Z

What type of PR is this?

/kind enhancement
/kind documentation
/kind feature

What this PR does / why we need it:

This PR updates the Sync kmeshctl Docs to Website GitHub Actions workflow to improve the synchronization of documentation between the kmesh-net/kmesh and kmesh-net/website repositories.
It ensures that the website/docs/kmeshctl directory is created if missing and populated with all files from kmesh/docs/ctl. Additionally, it enhances the workflow to detect and sync new changes (content modifications, added files, and deleted files) using rsync with checksum comparison, addressing previous issues where changes were not recognized.
This is necessary to maintain consistent and up-to-date documentation across repositories.
Workflow will create PR for any changes.
Emojis are used for better readability and visual scanning of logs

Which issue(s) this PR fixes:
Fixes #1412

Setup Instructions:
Step 1: Create a Fine-Grained Personal Access Token (PAT)

Go to: [GitHub Settings → Tokens (Fine-grained)](https://github.com/settings/tokens)
Click "Generate new token"
Configure:
    Name: kmesh-to-website-sync
    Repository access: Select kmesh-net/website
    Permissions:
        Contents → Read and write
        Pull Request → Read and write
Copy the token (you can't see it again)

Step 2: Add Secret to kmesh Repository

Go to: https://github.com/kmesh-net/kmesh/settings/secrets/actions
Click "New repository secret"
    Name: WEBSITE_PAT
    Value: Paste your PAT

Special notes for your reviewer:

Please verify that the WEBSITE_PAT secret is correctly configured in the kmesh-net/kmesh repository with write access to kmesh-net/website.
Note that the workflow uses absolute paths (/github/workspace/) and a git reset --hard step to ensure the Git index reflects rsynced changes; this may overwrite local uncommitted changes in the website repo during execution.

Does this PR introduce a user-facing change?:

NONE

Signed-off-by: GitHub Action <action@github.com>

gemini-code-assist · 2025-09-04T17:02:52Z

Note

Gemini is unable to generate a summary for this pull request due to the file types involved not being currently supported.

kmesh-bot · 2025-09-04T17:02:53Z

@yashisrani: The label(s) kind/documentation cannot be applied, because the repository doesn't have them.

Details

In response to this:

What type of PR is this?

/kind enhancement
/kind documentation
/kind feature

What this PR does / why we need it:

This PR updates the Sync kmeshctl Docs to Website GitHub Actions workflow to improve the synchronization of documentation between the kmesh-net/kmesh and kmesh-net/website repositories.

It ensures that the website/docs/kmeshctl directory is created if missing and populated with all files from kmesh/docs/ctl. Additionally, it enhances the workflow to detect and sync new changes (content modifications, added files, and deleted files) using rsync with checksum comparison, addressing previous issues where changes were not recognized.

This is necessary to maintain consistent and up-to-date documentation across repositories.

Workflow will create PR for any changes.

Emojis are used for better readability and visual scanning of logs

Which issue(s) this PR fixes:
Fixes #1412

Setup Instructions:
Step 1: Create a Fine-Grained Personal Access Token (PAT)

Go to: GitHub Settings → Tokens (Fine-grained)
Click "Generate new token"
Configure:
Name: kmesh-to-website-sync
Repository access: Select kmesh-net/website
Permissions:
Contents → Read and write
Pull Request → Read and write
Copy the token (you can't see it again)

Step 2: Add Secret to kmesh Repository

Go to: https://github.com/kmesh-net/kmesh/settings/secrets/actions
Click "New repository secret"
Name: WEBSITE_PAT
Value: Paste your PAT

Special notes for your reviewer:

Please verify that the WEBSITE_PAT secret is correctly configured in the kmesh-net/kmesh repository with write access to kmesh-net/website.

Note that the workflow uses absolute paths (/github/workspace/) and a git reset --hard step to ensure the Git index reflects rsynced changes; this may overwrite local uncommitted changes in the website repo during execution.

Does this PR introduce a user-facing change?:
NONE

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

codecov · 2025-09-04T17:24:04Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 38.26%. Comparing base (bf64ca4) to head (6fd6a3a).
⚠️ Report is 35 commits behind head on main.
see 6 files with indirect coverage changes

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7193230...6fd6a3a. Read the comment docs.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

hzxuzhonghu

BTW, can you show how it works in your own repo

hzxuzhonghu · 2025-09-05T03:05:36Z

.github/workflows/sync-kmeshctl-docs.yml

+      - name: 🤝 Create Pull Request
+        uses: peter-evans/create-pull-request@v5
+        with:
+          token: ${{ secrets.WEBSITE_PAT }}


we donot need to use a non exist token

here, we use ${{ secrets.GITHUB_TOKEN }}, but The GITHUB_TOKEN is limited to the repository’s scope, with restricted permissions, no organization-level access, and limitations in forks, often requiring a custom PAT for broader or cross-repository actions.

we want to create a PR for website repo, then we want to use PAT, and if we want to create PR for this same repo (kmesh), then we can use GITHUB_TOKEN

I can create the WEBSITE_PAT with the @kmesh-bot token, but first let me check if there exists one

please use secrets.GH_PAT, then we can have a try

hzxuzhonghu · 2025-09-05T03:06:41Z

.github/workflows/sync-kmeshctl-docs.yml

+          # Use timestamp for a guaranteed unique branch name
+          branch-suffix: timestamp
+          base: main
+          title: "docs: sync latest kmeshctl documentation"


add the PR number that triggered it

The workflow uses a push trigger, so ${{ github.event.number }} isn’t available (only for pull_request). I can add the commit SHA (${{ github.sha }}) for traceability or switch to a pull_request trigger. It successfully syncs kmesh/docs/ctl to kmesh-net/website.

OK, i think github.sha looks good, we need a unique id to trace

yashisrani · 2025-09-05T04:26:13Z

BTW, can you show how it works in your own repo

i shared private repo pr links one week ago on slack channel, you approved as well.

this workflow will first check on website, that kmeshctl folder available or not, if not then it will copy ctl folder from kmesh and create a pr for kmesh-website.

if kmeshctl folder is availble in website, then it will see the kmeshctl doc content changes, if changes are detected then it will create a pr for new changes in website.

hzxuzhonghu · 2025-09-08T12:12:07Z

.github/workflows/sync-kmeshctl-docs.yml

+          base: main
+          title: "docs: sync latest kmeshctl documentation"
+          body: |
+            This PR syncs the latest changes from [kmesh/docs/ctl](https://github.com/yashisrani/kmesh/tree/main/docs/ctl).


Please update

Signed-off-by: GitHub Action <action@github.com>

hzxuzhonghu · 2025-09-15T06:13:11Z

/lgtm
/approve

kmesh-bot · 2025-09-15T06:13:18Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hzxuzhonghu

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [hzxuzhonghu]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

feature(workflow): added Kmeshctl doc sycing workflow

be47c0c

Signed-off-by: GitHub Action <action@github.com>

kmesh-bot added the kind/enhancement New feature or request label Sep 4, 2025

kmesh-bot requested a review from kevin-wangzefeng September 4, 2025 17:02

kmesh-bot added the kind/feature label Sep 4, 2025

kmesh-bot requested a review from YaoZengzeng September 4, 2025 17:02

kmesh-bot added the size/M label Sep 4, 2025

hzxuzhonghu reviewed Sep 5, 2025

View reviewed changes

yashisrani changed the title ~~feature(workflow): added Kmeshctl doc sycing workflow~~ feature(workflow): added Kmeshctl doc syncing workflow Sep 5, 2025

yashisrani requested a review from hzxuzhonghu September 5, 2025 07:29

hzxuzhonghu reviewed Sep 8, 2025

View reviewed changes

fix(message): changed body message link

2af3865

Signed-off-by: GitHub Action <action@github.com>

yashisrani requested a review from hzxuzhonghu September 8, 2025 12:56

did: update kmeshctl sync workflow with GH_PAT and traceability

6fd6a3a

Signed-off-by: GitHub Action <action@github.com>

kmesh-bot assigned hzxuzhonghu Sep 15, 2025

kmesh-bot added the lgtm label Sep 15, 2025

kmesh-bot added the approved label Sep 15, 2025

kmesh-bot merged commit fa9c947 into kmesh-net:main Sep 15, 2025
12 checks passed

yashisrani mentioned this pull request Sep 15, 2025

REQUEST: New membership for Yash Israni #1505

Closed

6 tasks

Conversation

yashisrani commented Sep 4, 2025

Uh oh!

gemini-code-assist bot commented Sep 4, 2025

Uh oh!

kmesh-bot commented Sep 4, 2025

Uh oh!

codecov bot commented Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

hzxuzhonghu left a comment

Choose a reason for hiding this comment

Uh oh!

hzxuzhonghu Sep 5, 2025

Choose a reason for hiding this comment

Uh oh!

yashisrani Sep 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hzxuzhonghu Sep 8, 2025

Choose a reason for hiding this comment

Uh oh!

hzxuzhonghu Sep 8, 2025

Choose a reason for hiding this comment

Uh oh!

hzxuzhonghu Sep 5, 2025

Choose a reason for hiding this comment

Uh oh!

yashisrani Sep 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hzxuzhonghu Sep 8, 2025

Choose a reason for hiding this comment

Uh oh!

yashisrani commented Sep 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hzxuzhonghu Sep 8, 2025

Choose a reason for hiding this comment

Uh oh!

hzxuzhonghu commented Sep 15, 2025

Uh oh!

kmesh-bot commented Sep 15, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov bot commented Sep 4, 2025 •

edited

Loading

yashisrani Sep 5, 2025 •

edited

Loading

yashisrani Sep 5, 2025 •

edited

Loading

yashisrani commented Sep 5, 2025 •

edited

Loading