Skip to content

Commit 91a065f

Browse files
committed
Deploy preview for PR 84 🛫
1 parent bfcb9ba commit 91a065f

File tree

4 files changed

+14
-28
lines changed

4 files changed

+14
-28
lines changed

‎pr-preview/pr-84/develop.html‎

Lines changed: 11 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -560,41 +560,21 @@ <h2 id="configuring-the-gradle-build-file">Configuring the Gradle build file</h2
560560
contributed library Processing, after being installed. Please look at our
561561
<a href="troubleshooting.html">troubleshooting guide</a> if you suspect this is the case.</p>
562562
</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>
575563
</ol>
576-
<div class="admonition note">
577-
<p class="admonition-title">Note</p>
578-
<p>If you <a href="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>
581564
<h2 id="creating-examples">Creating examples</h2>
582565
<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>
583566
<div class="admonition note">
584567
<p class="admonition-title">Note</p>
585568
<p>The example sketch included in this template outputs the image shown on the home page.</p>
586569
</div>
587570
<h2 id="creating-the-release-artifacts">Creating the release artifacts</h2>
588-
<p>If you've already gone through the <a href="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>
590571
<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
595576
library, toggle <code>Tasks</code> &gt; <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>
598578
<li><strong>To build the library and create the release artifacts, run the Gradle task <code>buildReleaseArtifacts</code>.</strong>
599579
This task will create a <code>release</code> folder with needed artifacts. To do this, go to the Gradle menu
600580
(elephant), toggle <code>Tasks</code> &gt; <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>
612592
<code>deployToProcessingSketchbook</code>, which will create the release artifacts, and copy them into the
613593
sketchbook folder.</li>
614594
</ol>
595+
<div class="admonition note">
596+
<p class="admonition-title">Note</p>
597+
</div>
598+
<p>If you <a href="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>
615601
<h2 id="additional-documentation">Additional Documentation</h2>
616602
<p>See the following guides for more details:</p>
617603
<ul>

‎pr-preview/pr-84/release.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -545,7 +545,7 @@ <h2 id="releasing-on-github">Releasing on Github</h2>
545545
<div class="admonition important">
546546
<p class="admonition-title">Important</p>
547547
<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>
549549
</div>
550550
<div class="admonition note">
551551
<p class="admonition-title">Note</p>

0 commit comments

Comments
 (0)