Skip to content

Commit 59f9a68

Browse files
authored
Add a warning regarding HEAD commit of master (#861)
Merge pull request 861
1 parent bcfb3b9 commit 59f9a68

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,27 @@
1+
> [!WARNING]
2+
> **The `master` branch is under active development towards a semver-major release with non-backwards-compatible changes.**
3+
>
4+
> While you may use this theme in the current state either via the `jekyll-remote-theme` plugin or via a Gemfile, it is
5+
> recommended to point to a particular git ref that does not break your site's existing render and gradually update to a
6+
> newer git ref via a pull request after consulting this repository's commit-log and README.
7+
>
8+
> **Pointing directly to the `HEAD` commit of the `master` branch is risky and may contain changes that break your site.**
9+
>
10+
> Example of pointing to a particular git ref via `jekyll-remote-theme` plugin:
11+
> ```yaml
12+
> # _config.yml
13+
>
14+
> remote_theme: "jekyll/minima@1e8a445"
15+
> ```
16+
> Example of pointing to a particular git ref via `Gemfile` (with `theme: minima` in `_config.yml`)
17+
> ```ruby
18+
> # Gemfile
19+
>
20+
> gem "minima", github: "jekyll/minima", ref: "1e8a445"
21+
> ```
22+
23+
<br/><br/>
24+
125
<div align="center">
226
<p><em><strong>Disclaimer:</strong> The information here may vary depending on the version you're using.<br/>
327
Please refer to the <code>README.md</code> bundled within the theme-gem for information specific to your version or by pointing

0 commit comments

Comments
 (0)