Skip to content

feature(workflow): added versioning workflow#231

Merged
kmesh-bot merged 1 commit intokmesh-net:mainfrom
yashisrani:add/versioning-tool
Sep 10, 2025
Merged

feature(workflow): added versioning workflow#231
kmesh-bot merged 1 commit intokmesh-net:mainfrom
yashisrani:add/versioning-tool

Conversation

@yashisrani
Copy link
Copy Markdown
Contributor

@yashisrani yashisrani commented Sep 5, 2025

This PR addresses the issue in kmesh-net/kmesh#1412

This PR introduces and documents an automated versioning workflow for our Docusaurus documentation site using GitHub Actions. The goal is to automatically create versioned documentation branches whenever a new Git tag prefixed with v (e.g., v1.2.0) is pushed to the repository.

This ensures that:

  • Each released version of the product has a dedicated snapshot of its documentation.
  • Users can access historical documentation via the Docusaurus version dropdown.
  • Maintenance of past versions is streamlined and consistent.

How to Use:

  1. Tag a release: git tag v1.2.0 && git push origin v1.2.0
  2. Wait for the action to run
  3. Review and merge the auto-created PR

Permissions:

  • The workflow uses secrets.GITHUB_TOKEN to create branches and PRs.
  • Ensure the repo allows GitHub Actions to create pull requests (default in public repos; may require approval in private/org repos).

Important Considerations:

1. Supported Tag Format:

  • Tags must follow the format vX.Y.Z (e.g., v1.0.0, v2.3.4-alpha).
  • Tags like release-1.0 or 1.0.0 (without v) will not trigger the workflow.

2. Multi-Language Support:

  • Currently, only English (en) documentation is versioned.
  • Chinese (zh) and other locales will fallback to English content for older versions, per Docusaurus default behavior.
  • If localized versions are needed in the future, manual intervention or additional automation will be required.

3. Conflicts & Manual Fixes:

  • If two version tags are created rapidly, race conditions may occur.
  • If the PR shows unexpected changes (e.g., unrelated files), investigate possible merge drift or uncommitted local changes at time of tagging.

4. Do Not Run Locally:

  • Avoid running docusaurus docs:version manually unless absolutely necessary.
  • Doing so may cause conflicts with the automated flow or inconsistent version metadata.

Signed-off-by: GitHub Action <action@github.com>
@gemini-code-assist
Copy link
Copy Markdown

Note

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

@netlify
Copy link
Copy Markdown

netlify bot commented Sep 5, 2025

Deploy Preview for kmesh-net ready!

Name Link
🔨 Latest commit 666160b
🔍 Latest deploy log https://app.netlify.com/projects/kmesh-net/deploys/68babde1868d84000876d633
😎 Deploy Preview https://deploy-preview-231--kmesh-net.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@LiZhenCheng9527
Copy link
Copy Markdown
Collaborator

/lgtm

@kmesh-bot
Copy link
Copy Markdown
Collaborator

[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:

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

@kmesh-bot kmesh-bot merged commit 8633e44 into kmesh-net:main Sep 10, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants