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

fix : add patch for {docsify-ignore} and {docsify-ignore-all} #1351

Merged
merged 5 commits into from
Aug 22, 2020

Conversation

sy-records
Copy link
Member

@sy-records sy-records commented Aug 22, 2020

Summary

<!-- {docsify-ignore} --> is a major change and should be put into v5.

But a version has already been released, so a patch version has been added that is compatible with older versions and can be removed in v5.

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Docs
  • Build-related changes
  • Repo settings
  • Other, please describe:

If changing the UI of default theme, please provide the before/after screenshot:

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

  • When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

You have tested in the following browsers: (Providing a detailed version will be better.)

  • Chrome
  • Firefox
  • Safari
  • Edge
  • IE

If adding a new feature, the PR's description includes:

  • A convincing reason for adding this feature
  • Related documents have been updated
  • Related tests have been updated

To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.

@vercel
Copy link

vercel bot commented Aug 22, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/docsify-core/docsify-preview/kquxak60d
✅ Preview: https://docsify-preview-git-fork-sy-records-reset-1318.docsify-core.vercel.app

@codesandbox-ci
Copy link

codesandbox-ci bot commented Aug 22, 2020

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 204bfbb:

Sandbox Source
docsify-template Configuration

@sy-records sy-records added regression semver-major This needs a major release semver-patch This needs a patch release and removed semver-major This needs a major release labels Aug 22, 2020
Copy link
Member

@Koooooo-7 Koooooo-7 left a comment

Choose a reason for hiding this comment

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

I think we should keep the <!-- {docsify-ignore} --> and also let the {docsify-ignore} work fine, in case of causing the second breaking for users who may already use the new option.

@anikethsaha
Copy link
Member

I agree with @Koooooo-7 if we can manage to to ship the changes it would be great.
Though I will not wait too much cause we need to do the patch release soon

@sy-records
Copy link
Member Author

@anikethsaha @Koooooo-7 Done.

In #1318, I had a reference to the need for compatibility. #1318 (review)

@sy-records sy-records changed the title revert: Convert {docsify-ignore} and {docsify-ignore-all} to HTML comments fix : add patch for {docsify-ignore} and {docsify-ignore-all} Aug 22, 2020
Copy link
Member

@Koooooo-7 Koooooo-7 left a comment

Choose a reason for hiding this comment

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

TODO: when and how we will solve it.

@sy-records
Copy link
Member Author

TODO: when and how we will solve it.

Awaiting @trusktr and @jhildenbiddle approval, release v4.11.6

Copy link
Member

@trusktr trusktr left a comment

Choose a reason for hiding this comment

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

LGTM. For later, we can revert the PR merge commit to re-create these changes. We can open a PR with the changes, and just keep it open for v5 until we're ready.

@trusktr
Copy link
Member

trusktr commented Aug 22, 2020

Should we revert the removal of src from publish, then remove it as a breaking change for v5? Thoughts @jhildenbiddle?

@sy-records
Copy link
Member Author

Should we revert the removal of src from publish, then remove it as a breaking change for v5? Thoughts @jhildenbiddle?

#1343 (comment)

Copy link
Member

@trusktr trusktr left a comment

Choose a reason for hiding this comment

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

Thanks for doing this! This is good, to keep both forms.

Copy link
Member

@trusktr trusktr left a comment

Choose a reason for hiding this comment

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

Oops. Looks good! Let's get this in.

@sy-records
Copy link
Member Author

sy-records commented Aug 22, 2020

@trusktr Do we have to wait for @jhildenbiddle ? Or can we merge and release patch versions now?

@sy-records sy-records merged commit ce31607 into docsifyjs:develop Aug 22, 2020
@sy-records sy-records deleted the reset-1318 branch August 22, 2020 11:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
regression semver-patch This needs a patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants