Skip to content
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

feat: supporting independent versions for each sub products #463

Merged
merged 5 commits into from
Apr 11, 2024

Conversation

elliotxx
Copy link
Contributor

@elliotxx elliotxx commented Apr 10, 2024

1. Does this PR affect any open issues?(Y/N) and add issue references (e.g. "fix #123", "re #123".):

  • N
  • Y

2. What is the scope of this PR (e.g. component or file name):

Tagging a new version for each sub product:

  1. First, make sure the current docs version (the ./docs/[subProductNmae] directory) is ready to be frozen.
  2. Enter the specified sub product name and a new version number:
npm run docusaurus docs:version:[subProductNmae] [vMAJOR.MINOR]

Example:

npm run docusaurus docs:version:docs v0.12
npm run docusaurus docs:version:ctrlmesh v0.3
npm run docusaurus docs:version:ctrlmesh v0.1

Optional sub product names:

  • docs (alias for kusion)
  • operating
  • ctrlmesh

Format of version number: [vMAJOR.MINOR], e.g. v0.3, v0.13.

When tagging a new version of sub product, the document versioning mechanism will:

  • Copy the full docs/[subProductNmae] folder contents into a new [subProductNmae]_versioned_docs/version-[versionName]/ folder.
  • Create a versioned sidebars file based from your current sidebar configuration (if it exists) - saved as [subProductNmae]_versioned_sidebars/version-[versionName]-sidebars.json.
  • Append the new version number to [subProductNmae]_versions.json.

More see:

Screenshots:

image

image

image

3. Provide a description of the PR(e.g. more details, effects, motivations or doc link):

  • Affects user behaviors
  • Contains syntax changes
  • Contains variable changes
  • Contains experimental features
  • Performance regression: Consumes more CPU
  • Performance regression: Consumes more Memory
  • Other

4. Are there any breaking changes?(Y/N) and describe the breaking changes(e.g. more details, motivations or doc link):

  • N
  • Y

5. Are there test cases for these changes?(Y/N) select and add more details, references or doc links:

  • Unit test
  • Integration test
  • Benchmark (add benchmark stats below)
  • Manual test (add detailed scripts or steps below)
  • Other

6. Release note

Please refer to Release Notes Language Style Guide to write a quality release note.

None

Copy link

vercel bot commented Apr 10, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
kusionstack ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 10, 2024 8:16am

Copy link

github-actions bot commented Apr 10, 2024

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@elliotxx elliotxx changed the title feat: supporting independent versions for each sub products [WIP] feat: supporting independent versions for each sub products Apr 10, 2024
@elliotxx elliotxx force-pushed the support-independent-versions-for-each-sub-products branch from a8f1b7c to bfca4e1 Compare April 10, 2024 03:16
@elliotxx elliotxx force-pushed the support-independent-versions-for-each-sub-products branch from bfca4e1 to 7633fd6 Compare April 10, 2024 03:54
@elliotxx elliotxx force-pushed the support-independent-versions-for-each-sub-products branch from 7c48e7b to 58ead4d Compare April 10, 2024 06:30
@elliotxx elliotxx changed the title [WIP] feat: supporting independent versions for each sub products feat: supporting independent versions for each sub products Apr 10, 2024
@elliotxx elliotxx self-assigned this Apr 10, 2024
@elliotxx elliotxx added the enhancement New feature or request label Apr 10, 2024
Copy link
Contributor

@adohe adohe left a comment

Choose a reason for hiding this comment

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

/lgtm

@adohe adohe merged commit 7d26f74 into main Apr 11, 2024
4 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Apr 11, 2024
@adohe adohe deleted the support-independent-versions-for-each-sub-products branch April 11, 2024 02:49
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants