Skip to content

update: rc preview version support #225

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

Draft
wants to merge 6 commits into
base: release/5.0.0-rc.1
Choose a base branch
from

Conversation

Koooooo-7
Copy link
Member

@Koooooo-7 Koooooo-7 commented Jul 5, 2025

By default, always use the version accurate match if it is rc version of cli, otherwise, use the major.
Provide a rc option to use the latest rc version (preview version) now and in future.

@Koooooo-7 Koooooo-7 force-pushed the add-on-rc-support branch from 5d5a47d to 0f200d9 Compare July 5, 2025 04:39
@Koooooo-7 Koooooo-7 force-pushed the add-on-rc-support branch from 0f200d9 to e3231a2 Compare July 5, 2025 04:48
@Koooooo-7 Koooooo-7 mentioned this pull request Jul 5, 2025
2 tasks
@Koooooo-7 Koooooo-7 changed the title update: versioning update: rc preview version support Jul 5, 2025
@Koooooo-7 Koooooo-7 requested a review from sy-records July 5, 2025 05:40
README.md Outdated
- Type: string
- Default: `vue`
- Description: Choose a theme, defaults to `vue`, other choices are `buble`, `dark` and `pure`.
- `--previewRelease` option:
Copy link
Member

Choose a reason for hiding this comment

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

The option name is too long.

Copy link
Member Author

Choose a reason for hiding this comment

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

I shorter it as rcMode, does it make sense or any idea?

Copy link
Member

Choose a reason for hiding this comment

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

I recommend using --tag and -t, which can be selected as 4, 5, or rc.

Copy link
Member Author

@Koooooo-7 Koooooo-7 Jul 7, 2025

Choose a reason for hiding this comment

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

At the very beginning I have the same thoughts of it.

choices: [`${docsifyDefaultResourceVersion}`, 'rc'],

But I realized that the cli is designed to match the docsify version resources which is reasonable too.
If we provide the -tag, it means we should support all version resources generation in future, i.e. user can use cli v6 to generate v4 docsify also.
If the template or commands have incompatible change. it is hard to maintain (such as the themes).

So I think we could only provide the rc option specially for all latest rc version (cross version).
the cli of v5 provide the generation of v5 resources.
Ideally, if user wanna use v4, user needs to use v4 cli either.

Copy link
Member

Choose a reason for hiding this comment

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

I think replacing the version number and adding HTML content separately are the same thing.

Generate different HTML content based on different versions and perform replacements.

--local compatible with scenarios using local docsify.

Copy link
Member Author

@Koooooo-7 Koooooo-7 Jul 7, 2025

Choose a reason for hiding this comment

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

I think replacing the version number and adding HTML content separately are the same thing.
for instance now.

If we separated the templates/resources by versions that is feasible.
But the commands are incompatible and hard to handle.
i.e. The theme is only support vue now, If user wanna use v4 docsify, how does he use the --theme for it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants