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

Remove deprecated "page.header.cta_url" setting #4821

Merged
merged 1 commit into from
May 4, 2024

Conversation

iBug
Copy link
Collaborator

@iBug iBug commented May 4, 2024

Found this lying around while doing bde92b6. Thought I'd just remove it but hesitated for these reasons:

  • I'm a fan of Semantic Versioning and this is a breaking change for existing users.
    • Material for MkDocs is another theme that I use extensively, and it's doing a great job of following SemVer.
  • Too minor a change for bumping the "major" version (i.e. v5.0.0).
    • As far as I understand, a website theme is intended as a "root dependency" (facing end users directly), so there was no plan to follow SemVer from the beginning. The "major" version of this project is thus intended as "major overhauls" or "reincarnations (not really)".

Context:

  • Already deprecated since 4.13.0 (September 2018).

  • Not many sites would be affected: I glanced through the search results and there's not many live sites using Gemfile with MM version specified as "~> 4.something" (i.e. audience of SemVer).

    Most repos are full forks so they're not affected, and those who use the remote theme method without specifying a version will be affected nevertheless (regardless of whether we bump the version number).

Given the considerations above, I'm inclined to push this forward. Though for the first time of doing this, I'd like to ask for your input, @mmistakes.

@mmistakes
Copy link
Owner

@iBug Your logic above makes sense to me. I loosely followed SemVer with each release.

  • MAJOR releases were for redesigns or rewrites… didn’t happen often.
  • MINOR enhancements or breaking changes
  • PATCHES documentation changes or minor bug fixes

@iBug iBug merged commit ed883ea into mmistakes:master May 4, 2024
2 checks passed
@iBug iBug deleted the remove-cta-url branch May 4, 2024 20:35
minyoongi96 pushed a commit to minyoongi96/minyoongi96.github.io that referenced this pull request Aug 26, 2024
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.

2 participants