Skip to content

Commit ceccc4f

Browse files
committed
updated site
1 parent a653a7b commit ceccc4f

23 files changed

+1480
-1362
lines changed

Diff for: 1.x/docs/Combined+Pages+Pdf.md

+22
Original file line numberDiff line numberDiff line change
@@ -19721,6 +19721,28 @@ libraryDependencies ++=
1972119721
Seq.empty
1972219722
```
1972319723

19724+
### Publishing a plugin
19725+
19726+
Plugins can be published like any other projects. When publishing your plugin to a Maven-layout repository, use sbt 1.9.x or above.
19727+
19728+
However, there is one caveat if you attempt to publish your plugin to a repository that follows the Maven layout.
19729+
19730+
If your artifacts repository expect artifacts to be compliant with Maven layout and rejects artifacts that do not adhere to it you can:
19731+
1. (recommended) If you and consumers of your plugin use sbt 1.9.x or above
19732+
19733+
Since sbt 1.9, it tries to publish any plugin with both the new and legacy Maven style (for backward compatibility). The legacy Maven style is not fully compatible with Maven layout.
19734+
You need to disable it with:
19735+
`sbtPluginPublishLegacyMavenStyle := false`
19736+
Notice that you won't be able to consume this plugin with sbt older than 1.9, as it can only resolve the legacy Maven style (or you need to use the trick described in [sbt-vspp](https://github.com/esbeetee/sbt-vspp)).
19737+
3. If you use sbt < 1.9.x
19738+
19739+
You can use https://github.com/esbeetee/sbt-vspp/
19740+
5. If you cannot use sbt 1.9.x and you cannot/don't want to use sbt-vspp
19741+
19742+
There should be an option like `Suppress POM Consistency Checks` in your artifactory settings that will allow you to submit artifacts even if they don't fully follow Maven layout.
19743+
19744+
You can find more details about this in the [following issue](https://github.com/sbt/sbt/issues/3410).
19745+
1972419746
### Best Practices
1972519747

1972619748
If you're a plugin writer, please consult the [Plugins Best Practices][Plugins-Best-Practices]

Diff for: 1.x/docs/Combined+Pages.html

+14-1
Original file line numberDiff line numberDiff line change
@@ -12185,7 +12185,20 @@ <h4 class="toctitle">Contents</h4>
1218512185
Seq(&quot;org.example&quot; % &quot;windows-only&quot; % &quot;1.0&quot;)
1218612186
else
1218712187
Seq.empty
12188-
</code></pre><h3 id="Best+Practices">Best Practices<a href="#Best+Practices" class="header-link"><span class="header-link-content">&nbsp;</span></a></h3><p>If you’re a plugin writer, please consult the <a href="Plugins-Best-Practices.html">Plugins Best Practices</a>
12188+
</code></pre><h3 id="Publishing+a+plugin">Publishing a plugin<a href="#Publishing+a+plugin" class="header-link"><span class="header-link-content">&nbsp;</span></a></h3><p>Plugins can be published like any other projects. When publishing your plugin to a Maven-layout repository, use sbt 1.9.x or above.
12189+
</p><p>However, there is one caveat if you attempt to publish your plugin to a repository that follows the Maven layout.
12190+
</p><p>If your artifacts repository expect artifacts to be compliant with Maven layout and rejects artifacts that do not adhere to it you can:
12191+
1. (recommended) If you and consumers of your plugin use sbt 1.9.x or above
12192+
</p><p> Since sbt 1.9, it tries to publish any plugin with both the new and legacy Maven style (for backward compatibility). The legacy Maven style is not fully compatible with Maven layout.
12193+
You need to disable it with:
12194+
<code>sbtPluginPublishLegacyMavenStyle := false</code>
12195+
Notice that you won’t be able to consume this plugin with sbt older than 1.9, as it can only resolve the legacy Maven style (or you need to use the trick described in <a href="https://github.com/esbeetee/sbt-vspp">sbt-vspp</a>).
12196+
3. If you use sbt &lt; 1.9.x
12197+
</p><p> You can use https://github.com/esbeetee/sbt-vspp/
12198+
5. If you cannot use sbt 1.9.x and you cannot/don’t want to use sbt-vspp
12199+
</p><p> There should be an option like <code>Suppress POM Consistency Checks</code> in your artifactory settings that will allow you to submit artifacts even if they don’t fully follow Maven layout.
12200+
</p><p>You can find more details about this in the <a href="https://github.com/sbt/sbt/issues/3410">following issue</a>.
12201+
</p><h3 id="Best+Practices">Best Practices<a href="#Best+Practices" class="header-link"><span class="header-link-content">&nbsp;</span></a></h3><p>If you’re a plugin writer, please consult the <a href="Plugins-Best-Practices.html">Plugins Best Practices</a>
1218912202
page; it contains a set of guidelines to help you ensure that your
1219012203
plugin is consistent and plays well with other plugins.
1219112204
</p><p>For cross building sbt plugins see also <a href="Cross-Build-Plugins.html">Cross building plugins</a>.

Diff for: 1.x/docs/Combined+Pages.md

+22
Original file line numberDiff line numberDiff line change
@@ -19716,6 +19716,28 @@ libraryDependencies ++=
1971619716
Seq.empty
1971719717
```
1971819718

19719+
### Publishing a plugin
19720+
19721+
Plugins can be published like any other projects. When publishing your plugin to a Maven-layout repository, use sbt 1.9.x or above.
19722+
19723+
However, there is one caveat if you attempt to publish your plugin to a repository that follows the Maven layout.
19724+
19725+
If your artifacts repository expect artifacts to be compliant with Maven layout and rejects artifacts that do not adhere to it you can:
19726+
1. (recommended) If you and consumers of your plugin use sbt 1.9.x or above
19727+
19728+
Since sbt 1.9, it tries to publish any plugin with both the new and legacy Maven style (for backward compatibility). The legacy Maven style is not fully compatible with Maven layout.
19729+
You need to disable it with:
19730+
`sbtPluginPublishLegacyMavenStyle := false`
19731+
Notice that you won't be able to consume this plugin with sbt older than 1.9, as it can only resolve the legacy Maven style (or you need to use the trick described in [sbt-vspp](https://github.com/esbeetee/sbt-vspp)).
19732+
3. If you use sbt < 1.9.x
19733+
19734+
You can use https://github.com/esbeetee/sbt-vspp/
19735+
5. If you cannot use sbt 1.9.x and you cannot/don't want to use sbt-vspp
19736+
19737+
There should be an option like `Suppress POM Consistency Checks` in your artifactory settings that will allow you to submit artifacts even if they don't fully follow Maven layout.
19738+
19739+
You can find more details about this in the [following issue](https://github.com/sbt/sbt/issues/3410).
19740+
1971919741
### Best Practices
1972019742

1972119743
If you're a plugin writer, please consult the [Plugins Best Practices][Plugins-Best-Practices]

Diff for: 1.x/docs/Contents+in+Depth.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ <h4 class="toctitle">Contents</h4>
221221
<ul class="outline"> <li> <a href="Plugins.html#projectSettings+and+buildSettings">projectSettings and buildSettings </a> </li><li> <a href="Plugins.html#Implementing+plugin+dependencies">Implementing plugin dependencies </a> </li><li> <a href="Plugins.html#Root+plugins+and+triggered+plugins">Root plugins and triggered plugins </a> </li><li> <a href="Plugins.html#Controlling+the+import+with+autoImport">Controlling the import with autoImport </a> </li><li> <a href="Plugins.html#Example+Plugin">Example Plugin </a> </li><li> <a href="Plugins.html#Usage+example">Usage example </a> </li><li> <a href="Plugins.html#Global+plugins+example">Global plugins example </a> </li> </ul>
222222
</li><li> <a href="Plugins.html#Using+a+library+in+a+build+definition+example">Using a library in a build definition example </a>
223223
<ul class="outline"> <li> <a href="Plugins.html#1a%29+Manually+managed">1a) Manually managed </a> </li><li> <a href="Plugins.html#1b%29+Automatically+managed%3A+direct+editing+approach">1b) Automatically managed: direct editing approach </a> </li><li> <a href="Plugins.html#1c%29+Automatically+managed%3A+command-line+approach">1c) Automatically managed: command-line approach </a> </li><li> <a href="Plugins.html#1d%29+Project+dependency">1d) Project dependency </a> </li><li> <a href="Plugins.html#2%29+Use+the+library">2) Use the library </a> </li> </ul>
224-
</li><li> <a href="Plugins.html#Best+Practices">Best Practices </a> </li></ul></li><li><div><a href="Plugins-Best-Practices.html">Plugins Best Practices</a></div><ul class="outline"><li> <a href="Plugins-Best-Practices.html#Key+naming+convention%3A+Use+prefix">Key naming convention: Use prefix </a> </li><li> <a href="Plugins-Best-Practices.html#Artifact+naming+convention">Artifact naming convention </a> </li><li> <a href="Plugins-Best-Practices.html#%28optional%29+Plugin+naming+convention">(optional) Plugin naming convention </a> </li><li> <a href="Plugins-Best-Practices.html#Don++t+use+default+package">Don t use default package </a> </li><li> <a href="Plugins-Best-Practices.html#Get+your+plugins+known">Get your plugins known </a> </li><li> <a href="Plugins-Best-Practices.html#Reuse+existing+keys">Reuse existing keys </a> </li><li> <a href="Plugins-Best-Practices.html#Use+settings+and+tasks.+Avoid+commands.">Use settings and tasks. Avoid commands. </a> </li><li> <a href="Plugins-Best-Practices.html#Provide+core+feature+in+a+plain+old+Scala+object">Provide core feature in a plain old Scala object </a> </li><li> <a href="Plugins-Best-Practices.html#Configuration+advice">Configuration advice </a>
224+
</li><li> <a href="Plugins.html#Publishing+a+plugin">Publishing a plugin </a> </li><li> <a href="Plugins.html#Best+Practices">Best Practices </a> </li></ul></li><li><div><a href="Plugins-Best-Practices.html">Plugins Best Practices</a></div><ul class="outline"><li> <a href="Plugins-Best-Practices.html#Key+naming+convention%3A+Use+prefix">Key naming convention: Use prefix </a> </li><li> <a href="Plugins-Best-Practices.html#Artifact+naming+convention">Artifact naming convention </a> </li><li> <a href="Plugins-Best-Practices.html#%28optional%29+Plugin+naming+convention">(optional) Plugin naming convention </a> </li><li> <a href="Plugins-Best-Practices.html#Don++t+use+default+package">Don t use default package </a> </li><li> <a href="Plugins-Best-Practices.html#Get+your+plugins+known">Get your plugins known </a> </li><li> <a href="Plugins-Best-Practices.html#Reuse+existing+keys">Reuse existing keys </a> </li><li> <a href="Plugins-Best-Practices.html#Use+settings+and+tasks.+Avoid+commands.">Use settings and tasks. Avoid commands. </a> </li><li> <a href="Plugins-Best-Practices.html#Provide+core+feature+in+a+plain+old+Scala+object">Provide core feature in a plain old Scala object </a> </li><li> <a href="Plugins-Best-Practices.html#Configuration+advice">Configuration advice </a>
225225
<ul class="outline"> <li> <a href="Plugins-Best-Practices.html#You+probably+won++t+need+your+own+configuration">You probably won t need your own configuration </a> </li><li> <a href="Plugins-Best-Practices.html#When+to+define+your+own+configuration">When to define your own configuration </a> </li><li> <a href="Plugins-Best-Practices.html#Playing+nice+with+configurations">Playing nice with configurations </a> </li><li> <a href="Plugins-Best-Practices.html#Provide+raw+settings+and+configured+settings">Provide raw settings and configured settings </a> </li> </ul>
226226
</li><li> <a href="Plugins-Best-Practices.html#Scoping+advice">Scoping advice </a>
227227
<ul class="outline"> <li> <a href="Plugins-Best-Practices.html#Provide+default+values+in++globalSettings">Provide default values in globalSettings </a> </li><li> <a href="Plugins-Best-Practices.html#Using+a+++main+++task+scope+for+settings">Using a main task scope for settings </a> </li><li> <a href="Plugins-Best-Practices.html#Rewiring+existing+keys+in++globalSettings">Rewiring existing keys in globalSettings </a> </li> </ul>

Diff for: 1.x/docs/Plugins.html

+14-1
Original file line numberDiff line numberDiff line change
@@ -404,7 +404,20 @@ <h2 id="Plugins">Plugins<a href="#Plugins" class="header-link"><span class="head
404404
Seq(&quot;org.example&quot; % &quot;windows-only&quot; % &quot;1.0&quot;)
405405
else
406406
Seq.empty
407-
</code></pre><h3 id="Best+Practices">Best Practices<a href="#Best+Practices" class="header-link"><span class="header-link-content">&nbsp;</span></a></h3><p>If you’re a plugin writer, please consult the <a href="Plugins-Best-Practices.html">Plugins Best Practices</a>
407+
</code></pre><h3 id="Publishing+a+plugin">Publishing a plugin<a href="#Publishing+a+plugin" class="header-link"><span class="header-link-content">&nbsp;</span></a></h3><p>Plugins can be published like any other projects. When publishing your plugin to a Maven-layout repository, use sbt 1.9.x or above.
408+
</p><p>However, there is one caveat if you attempt to publish your plugin to a repository that follows the Maven layout.
409+
</p><p>If your artifacts repository expect artifacts to be compliant with Maven layout and rejects artifacts that do not adhere to it you can:
410+
1. (recommended) If you and consumers of your plugin use sbt 1.9.x or above
411+
</p><p> Since sbt 1.9, it tries to publish any plugin with both the new and legacy Maven style (for backward compatibility). The legacy Maven style is not fully compatible with Maven layout.
412+
You need to disable it with:
413+
<code>sbtPluginPublishLegacyMavenStyle := false</code>
414+
Notice that you won’t be able to consume this plugin with sbt older than 1.9, as it can only resolve the legacy Maven style (or you need to use the trick described in <a href="https://github.com/esbeetee/sbt-vspp">sbt-vspp</a>).
415+
3. If you use sbt &lt; 1.9.x
416+
</p><p> You can use https://github.com/esbeetee/sbt-vspp/
417+
5. If you cannot use sbt 1.9.x and you cannot/don’t want to use sbt-vspp
418+
</p><p> There should be an option like <code>Suppress POM Consistency Checks</code> in your artifactory settings that will allow you to submit artifacts even if they don’t fully follow Maven layout.
419+
</p><p>You can find more details about this in the <a href="https://github.com/sbt/sbt/issues/3410">following issue</a>.
420+
</p><h3 id="Best+Practices">Best Practices<a href="#Best+Practices" class="header-link"><span class="header-link-content">&nbsp;</span></a></h3><p>If you’re a plugin writer, please consult the <a href="Plugins-Best-Practices.html">Plugins Best Practices</a>
408421
page; it contains a set of guidelines to help you ensure that your
409422
plugin is consistent and plays well with other plugins.
410423
</p><p>For cross building sbt plugins see also <a href="Cross-Build-Plugins.html">Cross building plugins</a>.

Diff for: 1.x/docs/es/offline/pamflet.manifest

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
CACHE MANIFEST
2-
# Wed Jan 31 13:25:57 UTC 2024
2+
# Sat Feb 17 13:23:48 UTC 2024
33
index.html
44
Getting-Started.html
55
Setup.html

Diff for: 1.x/docs/es/sbt-reference.pdf

-2 Bytes
Binary file not shown.

Diff for: 1.x/docs/ja/offline/pamflet.manifest

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
CACHE MANIFEST
2-
# Wed Jan 31 13:25:51 UTC 2024
2+
# Sat Feb 17 13:23:38 UTC 2024
33
index.html
44
Getting-Started.html
55
Setup.html

Diff for: 1.x/docs/ja/sbt-reference.pdf

-2 Bytes
Binary file not shown.

Diff for: 1.x/docs/offline/Combined+Pages.html

+14-1
Original file line numberDiff line numberDiff line change
@@ -12185,7 +12185,20 @@ <h4 class="toctitle">Contents</h4>
1218512185
Seq(&quot;org.example&quot; % &quot;windows-only&quot; % &quot;1.0&quot;)
1218612186
else
1218712187
Seq.empty
12188-
</code></pre><h3 id="Best+Practices">Best Practices<a href="#Best+Practices" class="header-link"><span class="header-link-content">&nbsp;</span></a></h3><p>If you’re a plugin writer, please consult the <a href="Plugins-Best-Practices.html">Plugins Best Practices</a>
12188+
</code></pre><h3 id="Publishing+a+plugin">Publishing a plugin<a href="#Publishing+a+plugin" class="header-link"><span class="header-link-content">&nbsp;</span></a></h3><p>Plugins can be published like any other projects. When publishing your plugin to a Maven-layout repository, use sbt 1.9.x or above.
12189+
</p><p>However, there is one caveat if you attempt to publish your plugin to a repository that follows the Maven layout.
12190+
</p><p>If your artifacts repository expect artifacts to be compliant with Maven layout and rejects artifacts that do not adhere to it you can:
12191+
1. (recommended) If you and consumers of your plugin use sbt 1.9.x or above
12192+
</p><p> Since sbt 1.9, it tries to publish any plugin with both the new and legacy Maven style (for backward compatibility). The legacy Maven style is not fully compatible with Maven layout.
12193+
You need to disable it with:
12194+
<code>sbtPluginPublishLegacyMavenStyle := false</code>
12195+
Notice that you won’t be able to consume this plugin with sbt older than 1.9, as it can only resolve the legacy Maven style (or you need to use the trick described in <a href="https://github.com/esbeetee/sbt-vspp">sbt-vspp</a>).
12196+
3. If you use sbt &lt; 1.9.x
12197+
</p><p> You can use https://github.com/esbeetee/sbt-vspp/
12198+
5. If you cannot use sbt 1.9.x and you cannot/don’t want to use sbt-vspp
12199+
</p><p> There should be an option like <code>Suppress POM Consistency Checks</code> in your artifactory settings that will allow you to submit artifacts even if they don’t fully follow Maven layout.
12200+
</p><p>You can find more details about this in the <a href="https://github.com/sbt/sbt/issues/3410">following issue</a>.
12201+
</p><h3 id="Best+Practices">Best Practices<a href="#Best+Practices" class="header-link"><span class="header-link-content">&nbsp;</span></a></h3><p>If you’re a plugin writer, please consult the <a href="Plugins-Best-Practices.html">Plugins Best Practices</a>
1218912202
page; it contains a set of guidelines to help you ensure that your
1219012203
plugin is consistent and plays well with other plugins.
1219112204
</p><p>For cross building sbt plugins see also <a href="Cross-Build-Plugins.html">Cross building plugins</a>.

Diff for: 1.x/docs/offline/Combined+Pages.md

+22
Original file line numberDiff line numberDiff line change
@@ -19716,6 +19716,28 @@ libraryDependencies ++=
1971619716
Seq.empty
1971719717
```
1971819718

19719+
### Publishing a plugin
19720+
19721+
Plugins can be published like any other projects. When publishing your plugin to a Maven-layout repository, use sbt 1.9.x or above.
19722+
19723+
However, there is one caveat if you attempt to publish your plugin to a repository that follows the Maven layout.
19724+
19725+
If your artifacts repository expect artifacts to be compliant with Maven layout and rejects artifacts that do not adhere to it you can:
19726+
1. (recommended) If you and consumers of your plugin use sbt 1.9.x or above
19727+
19728+
Since sbt 1.9, it tries to publish any plugin with both the new and legacy Maven style (for backward compatibility). The legacy Maven style is not fully compatible with Maven layout.
19729+
You need to disable it with:
19730+
`sbtPluginPublishLegacyMavenStyle := false`
19731+
Notice that you won't be able to consume this plugin with sbt older than 1.9, as it can only resolve the legacy Maven style (or you need to use the trick described in [sbt-vspp](https://github.com/esbeetee/sbt-vspp)).
19732+
3. If you use sbt < 1.9.x
19733+
19734+
You can use https://github.com/esbeetee/sbt-vspp/
19735+
5. If you cannot use sbt 1.9.x and you cannot/don't want to use sbt-vspp
19736+
19737+
There should be an option like `Suppress POM Consistency Checks` in your artifactory settings that will allow you to submit artifacts even if they don't fully follow Maven layout.
19738+
19739+
You can find more details about this in the [following issue](https://github.com/sbt/sbt/issues/3410).
19740+
1971919741
### Best Practices
1972019742

1972119743
If you're a plugin writer, please consult the [Plugins Best Practices][Plugins-Best-Practices]

0 commit comments

Comments
 (0)