You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: pr-preview/pr-84/develop.html
+11-25Lines changed: 11 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -560,41 +560,21 @@ <h2 id="configuring-the-gradle-build-file">Configuring the Gradle build file</h2
560
560
contributed library Processing, after being installed. Please look at our
561
561
<ahref="troubleshooting.html">troubleshooting guide</a> if you suspect this is the case.</p>
562
562
</li>
563
-
<li>
564
-
<p><strong>Define the <code>version</code> of your library in <code>build.gradle.kts</code>.</strong> This value will also be
565
-
included in the release artifact <code>library.properties</code>. The version of your library usually
566
-
follows semantic versioning (semver), which uses three numbers separated by dots:
567
-
"MAJOR.MINOR.PATCH" (e.g., "1.0.0"). </p>
568
-
<ul>
569
-
<li>MAJOR: Increases when you make incompatible changes.</li>
570
-
<li>MINOR: Increases when you add new features that are backward-compatible.</li>
571
-
<li>PATCH: Increases when you make backward-compatible bug fixes.</li>
572
-
</ul>
573
-
<p>You will update these numbers as you release new versions of your library.</p>
574
-
</li>
575
563
</ol>
576
-
<divclass="admonition note">
577
-
<pclass="admonition-title">Note</p>
578
-
<p>If you <ahref="https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository">release your library on Github</a>,
579
-
the prettyVersion field in your release artifacts will reflect your release tag instead of the <code>version</code> defined in <code>build.gradle.kts</code>, as a helpful automation.</p>
580
-
</div>
581
564
<h2id="creating-examples">Creating examples</h2>
582
565
<p>Examples help users understand your library’s functionality, it is recommended that you include several clear and well-commented samples sketches in the <code>examples</code> folder.</p>
583
566
<divclass="admonition note">
584
567
<pclass="admonition-title">Note</p>
585
568
<p>The example sketch included in this template outputs the image shown on the home page.</p>
586
569
</div>
587
570
<h2id="creating-the-release-artifacts">Creating the release artifacts</h2>
588
-
<p>If you've already gone through the <ahref="getting-started.html#first-steps">Getting started</a> guide, you will have
589
-
already run Gradle tasks, and edited the <code>release.properties</code> file.</p>
590
571
<ol>
591
-
<li>Fill in the file <code>release.properties</code> with information for your library. This information will be
592
-
used by Gradle to create the <code>library.properties</code> file, which is one of the required release
593
-
artifacts, used by the website and Contribution Manager to describe your library. In the file itself,
594
-
There are comments to guide you. To create just the <code>library.properties</code> file without building the
572
+
<li>Fill in the file <code>release.properties</code> with information for your library. In the file itself,
573
+
There are comments to guide you. This information will be used by Gradle to create the
574
+
<code>library.properties</code> file, which is one of the required release artifacts, used by the website
575
+
and Contribution Manager to describe your library. To create just the <code>library.properties</code> file without building the
595
576
library, toggle <code>Tasks</code> > <code>processing</code> and double click <code>writeLibraryProperties</code>. This task will
596
-
copy all the values in <code>release.properties</code>, and also include the <code>version</code> in your <code>build.gradle.kts</code>
597
-
file as <code>prettyVersion</code>.</li>
577
+
copy all the values in <code>release.properties</code>.</li>
598
578
<li><strong>To build the library and create the release artifacts, run the Gradle task <code>buildReleaseArtifacts</code>.</strong>
599
579
This task will create a <code>release</code> folder with needed artifacts. To do this, go to the Gradle menu
600
580
(elephant), toggle <code>Tasks</code> > <code>processing</code> and double click <code>buildReleaseArtifacts</code>. This task
@@ -612,6 +592,12 @@ <h2 id="creating-the-release-artifacts">Creating the release artifacts</h2>
612
592
<code>deployToProcessingSketchbook</code>, which will create the release artifacts, and copy them into the
613
593
sketchbook folder.</li>
614
594
</ol>
595
+
<divclass="admonition note">
596
+
<pclass="admonition-title">Note</p>
597
+
</div>
598
+
<p>If you <ahref="https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository">release your library on Github</a>,
599
+
your release tag will be used for the value of the <code>prettyVersion</code> field, overwriting the value for <code>prettyVersion</code>
600
+
defined in <code>release.properties</code>, as a helpful automation.</p>
Copy file name to clipboardExpand all lines: pr-preview/pr-84/release.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -545,7 +545,7 @@ <h2 id="releasing-on-github">Releasing on Github</h2>
545
545
<divclass="admonition important">
546
546
<pclass="admonition-title">Important</p>
547
547
<p>The release tag created on Github will be propagated to the release artifacts.
548
-
Specifically the tag, without the leading <code>v</code>, will be used for the <code>prettyVersion</code> in the txt file and <code>library.properties</code> file in the zip. This overwrites the value input for <code>version</code> in the <code>build.gradle.kts</code> file.</p>
548
+
Specifically the tag, without the leading <code>v</code>, will be used for the <code>prettyVersion</code> in the txt file and <code>library.properties</code> file in the zip. This overwrites the value input for <code>prettyVersion</code> in the <code>release.properties</code> file.</p>
0 commit comments