<p>This change configures the Gradle build to generate "start scripts" for<br>
each Bisq executable (e.g. Bisq Desktop, Bisq Seednode, etc) in the root<br>
project directory, such that after invoking <code>./gradle build</code>, the<br>
following executable scripts become available:</p>
<pre><code>~/Work/bisq-network/bisq
$ ls -1 | egrep '(bisq*|lib)'
bisq-desktop
bisq-desktop.bat
bisq-monitor
bisq-monitor.bat
bisq-relay
bisq-relay.bat
bisq-seednode
bisq-seednode.bat
bisq-statsnode
bisq-statsnode.bat
lib
</code></pre>
<p>This makes it possible for users (developers) to easily discover and use<br>
these scripts in an idiomatic and platform-agnostic way as opposed to<br>
the previous situation where we would advise users to run e.g.</p>
<pre><code>java -jar desktop/build/libs/desktop-0.8.0-SNAPSHOT-all.jar
</code></pre>
<p>This approach works, but is cumbersome and focuses unnecessarily on the<br>
Java-based nature of the project. Now, with the changes in this commit,<br>
the user would simply run:</p>
<pre><code>./bisq-desktop
</code></pre>
<p>The 'lib' directory shown above contains all the jar files necessary to<br>
construct classpaths for these various scripts. The 'cleanInstallDist'<br>
task deletes the 'bisq-*' files and the 'lib' directory, and the default<br>
'clean' task has been configured to depend on the 'cleanInstallDist'<br>
task to ensure this cleanup happens automatically when most users would<br>
expect it.</p>
<p>In the future, these same scripts can be used when installing Bisq<br>
executables properly on users' systems via package managers like Brew<br>
and Apt. The goal is to have the user experience around running<br>
<code>bisq-desktop</code> (and more importantly, the forthcoming <code>bisqd</code>) be<br>
similar in every way to installing and using <code>bitcoind</code>, <code>lnd</code> and other<br>
idiomatic *nix-style utilities, be they Bitcoin-related or not.</p>
<p>See the changes in docs/build.md and docs/dev-setup.md for a further<br>
sense of the how this change impacts the developer experience.</p>
<hr>
<h4>You can view, comment on, or merge this pull request online at:</h4>
<p> <a href='https://github.com/bisq-network/bisq/pull/1956'>https://github.com/bisq-network/bisq/pull/1956</a></p>
<h4>Commit Summary</h4>
<ul>
<li>Generate scripts for Bisq executables in root dir</li>
</ul>
<h4>File Changes</h4>
<ul>
<li>
<strong>M</strong>
<a href="https://github.com/bisq-network/bisq/pull/1956/files#diff-0">.gitignore</a>
(3)
</li>
<li>
<strong>M</strong>
<a href="https://github.com/bisq-network/bisq/pull/1956/files#diff-1">build.gradle</a>
(48)
</li>
<li>
<strong>M</strong>
<a href="https://github.com/bisq-network/bisq/pull/1956/files#diff-2">docs/build.md</a>
(4)
</li>
<li>
<strong>M</strong>
<a href="https://github.com/bisq-network/bisq/pull/1956/files#diff-3">docs/dev-setup.md</a>
(6)
</li>
</ul>
<h4>Patch Links:</h4>
<ul>
<li><a href='https://github.com/bisq-network/bisq/pull/1956.patch'>https://github.com/bisq-network/bisq/pull/1956.patch</a></li>
<li><a href='https://github.com/bisq-network/bisq/pull/1956.diff'>https://github.com/bisq-network/bisq/pull/1956.diff</a></li>
</ul>
<p style="font-size:small;-webkit-text-size-adjust:none;color:#666;">—<br />You are receiving this because you are subscribed to this thread.<br />Reply to this email directly, <a href="https://github.com/bisq-network/bisq/pull/1956">view it on GitHub</a>, or <a href="https://github.com/notifications/unsubscribe-auth/AkpZtoRNIOHuvxn0cU1xL8PwWLOi7R6yks5ux__VgaJpZM4YwtKg">mute the thread</a>.<img src="https://github.com/notifications/beacon/AkpZttvDkwRobZ5SNgdBsG327ho7tC9Gks5ux__VgaJpZM4YwtKg.gif" height="1" width="1" alt="" /></p>
<script type="application/json" data-scope="inboxmarkup">{"api_version":"1.0","publisher":{"api_key":"05dde50f1d1a384dd78767c55493e4bb","name":"GitHub"},"entity":{"external_key":"github/bisq-network/bisq","title":"bisq-network/bisq","subtitle":"GitHub repository","main_image_url":"https://assets-cdn.github.com/images/email/message_cards/header.png","avatar_image_url":"https://assets-cdn.github.com/images/email/message_cards/avatar.png","action":{"name":"Open in GitHub","url":"https://github.com/bisq-network/bisq"}},"updates":{"snippets":[{"icon":"DESCRIPTION","message":"Generate scripts for Bisq executables in root dir (#1956)"}],"action":{"name":"View Pull Request","url":"https://github.com/bisq-network/bisq/pull/1956"}}}</script>
<script type="application/ld+json">[
{
"@context": "http://schema.org",
"@type": "EmailMessage",
"potentialAction": {
"@type": "ViewAction",
"target": "https://github.com/bisq-network/bisq/pull/1956",
"url": "https://github.com/bisq-network/bisq/pull/1956",
"name": "View Pull Request"
},
"description": "View this Pull Request on GitHub",
"publisher": {
"@type": "Organization",
"name": "GitHub",
"url": "https://github.com"
}
},
{
"@type": "MessageCard",
"@context": "http://schema.org/extensions",
"hideOriginalBody": "false",
"originator": "AF6C5A86-E920-430C-9C59-A73278B5EFEB",
"title": "Generate scripts for Bisq executables in root dir (#1956)",
"sections": [
{
"text": "",
"activityTitle": "**Chris Beams**",
"activityImage": "https://assets-cdn.github.com/images/email/message_cards/avatar.png",
"activitySubtitle": "@cbeams",
"facts": [
]
},
{
"title": "Commit Summary",
"facts": [
{
"name": "fc0491d",
"value": "Generate scripts for Bisq executables in root dir"
}
]
},
{
"title": "File Changes",
"facts": [
{
"name": "Modified",
"value": "[.gitignore](https://github.com/bisq-network/bisq/pull/1956/files#diff-0) (3 changes)"
},
{
"name": "Modified",
"value": "[build.gradle](https://github.com/bisq-network/bisq/pull/1956/files#diff-1) (48 changes)"
},
{
"name": "Modified",
"value": "[docs/build.md](https://github.com/bisq-network/bisq/pull/1956/files#diff-2) (4 changes)"
},
{
"name": "Modified",
"value": "[docs/dev-setup.md](https://github.com/bisq-network/bisq/pull/1956/files#diff-3) (6 changes)"
}
]
}
],
"potentialAction": [
{
"name": "Add a comment",
"@type": "ActionCard",
"inputs": [
{
"isMultiLine": true,
"@type": "TextInput",
"id": "IssueComment",
"isRequired": false
}
],
"actions": [
{
"name": "Comment",
"@type": "HttpPOST",
"target": "https://api.github.com",
"body": "{\n\"commandName\": \"IssueComment\",\n\"repositoryFullName\": \"bisq-network/bisq\",\n\"issueId\": 1956,\n\"IssueComment\": \"{{IssueComment.value}}\"\n}"
}
]
},
{
"name": "Close pull request",
"@type": "HttpPOST",
"target": "https://api.github.com",
"body": "{\n\"commandName\": \"PullRequestClose\",\n\"repositoryFullName\": \"bisq-network/bisq\",\n\"pullRequestId\": 1956\n}"
},
{
"targets": [
{
"os": "default",
"uri": "https://github.com/bisq-network/bisq/pull/1956"
}
],
"@type": "OpenUri",
"name": "View on GitHub"
},
{
"targets": [
{
"os": "default",
"uri": "https://github.com/bisq-network/bisq/pull/1956.patch"
}
],
"@type": "OpenUri",
"name": "View patch"
},
{
"targets": [
{
"os": "default",
"uri": "https://github.com/bisq-network/bisq/pull/1956.diff"
}
],
"@type": "OpenUri",
"name": "View diff"
},
{
"name": "Unsubscribe",
"@type": "HttpPOST",
"target": "https://api.github.com",
"body": "{\n\"commandName\": \"MuteNotification\",\n\"threadId\": 415421088\n}"
}
],
"themeColor": "26292E"
}
]</script>