这是indexloc提供的服务，不要输入任何密码
Skip to content

Add a warning regarding HEAD commit of master #861

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Mar 5, 2025
Merged

Add a warning regarding HEAD commit of master #861

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f8d0b97
Add a warning regarding HEAD commit of `master`
ashmaroli Mar 5, 2025
86c93bc
add some more details
ashmaroli Mar 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
> [!WARNING]
> **The `master` branch is under active development towards a semver-major release with non-backwards-compatible changes.**
>
> While you may use this theme in the current state either via the `jekyll-remote-theme` plugin or via a Gemfile, it is
> recommended to point to a particular git ref that does not break your site's existing render and gradually update to a
> newer git ref via a pull request after consulting this repository's commit-log and README.
>
> **Pointing directly to the `HEAD` commit of the `master` branch is risky and may contain changes that break your site.**
>
> Example of pointing to a particular git ref via `jekyll-remote-theme` plugin:
> ```yaml
> # _config.yml
>
> remote_theme: "jekyll/minima@1e8a445"
> ```
> Example of pointing to a particular git ref via `Gemfile` (with `theme: minima` in `_config.yml`)
> ```ruby
> # Gemfile
>
> gem "minima", github: "jekyll/minima", ref: "1e8a445"
> ```

<br/><br/>

<div align="center">
<p><em><strong>Disclaimer:</strong> The information here may vary depending on the version you're using.<br/>
Please refer to the <code>README.md</code> bundled within the theme-gem for information specific to your version or by pointing
Expand Down