You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hop.apache.org by ha...@apache.org on 2021/10/29 07:48:48 UTC
[incubator-hop] branch master updated: HOP-3460 extended git
information
This is an automated email from the ASF dual-hosted git repository.
hansva pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-hop.git
The following commit(s) were added to refs/heads/master by this push:
new 32640d6 HOP-3460 extended git information
new 1d72e50 Merge pull request #1179 from bamaer/HOP-3460
32640d6 is described below
commit 32640d6b3dcd4b34534d965fe9e39c830e49cea6
Author: Bart Maertens <ba...@know.bi>
AuthorDate: Thu Oct 28 21:08:09 2021 +0200
HOP-3460 extended git information
---
.../ROOT/assets/images/icons/arrow-right.svg | 14 +++++++
.../modules/ROOT/assets/images/icons/git-add.svg | 25 +++++++++++++
.../ROOT/assets/images/icons/git-commit.svg | 4 ++
.../modules/ROOT/assets/images/icons/git-info.svg | 32 ++++++++++++++++
.../ROOT/assets/images/icons/git-revert.svg | 20 ++++++++++
.../modules/ROOT/assets/images/icons/pull.svg | 43 ++++++++++++++++++++++
.../modules/ROOT/assets/images/icons/push.svg | 43 ++++++++++++++++++++++
.../modules/ROOT/assets/images/icons/rename.svg | 15 ++++++++
.../modules/ROOT/pages/hop-gui/hop-gui-git.adoc | 39 ++++++++++++--------
9 files changed, 220 insertions(+), 15 deletions(-)
diff --git a/docs/hop-user-manual/modules/ROOT/assets/images/icons/arrow-right.svg b/docs/hop-user-manual/modules/ROOT/assets/images/icons/arrow-right.svg
new file mode 100644
index 0000000..d2f44e0
--- /dev/null
+++ b/docs/hop-user-manual/modules/ROOT/assets/images/icons/arrow-right.svg
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+ xmlns="http://www.w3.org/2000/svg"
+ version="1.1"
+ viewBox="0 0 16 16"
+ class="bi bi-arrow-right"
+ fill="currentColor"
+ height="16"
+ width="16">
+ <path
+ style="fill:#0e3a5a;fill-opacity:1"
+ d="M1 8a.5.5 0 0 1 .5-.5h11.793l-3.147-3.146a.5.5 0 0 1 .708-.708l4 4a.5.5 0 0 1 0 .708l-4 4a.5.5 0 0 1-.708-.708L13.293 8.5H1.5A.5.5 0 0 1 1 8z"
+ fill-rule="evenodd"/>
+</svg>
diff --git a/docs/hop-user-manual/modules/ROOT/assets/images/icons/git-add.svg b/docs/hop-user-manual/modules/ROOT/assets/images/icons/git-add.svg
new file mode 100644
index 0000000..0b4aba5
--- /dev/null
+++ b/docs/hop-user-manual/modules/ROOT/assets/images/icons/git-add.svg
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+ xmlns="http://www.w3.org/2000/svg"
+ enable-background="new 0 0 97 97"
+ viewBox="0 0 97 97"
+ height="97px"
+ width="97px"
+ y="0px"
+ x="0px"
+ version="1.1">
+ <g
+ transform="matrix(0.84298576,0,0,0.84298576,0.40113214,0.40160318)"
+ >
+ <path
+ style="fill:#f05133"
+ d="M 92.71,44.408 52.591,4.291 c -2.31,-2.311 -6.057,-2.311 -8.369,0 l -8.33,8.332 10.567,10.567 c 2.456,-0.83 5.272,-0.273 7.229,1.685 1.969,1.97 2.521,4.81 1.67,7.275 l 10.186,10.185 c 2.465,-0.85 5.307,-0.3 7.275,1.671 2.75,2.75 2.75,7.206 0,9.958 -2.752,2.751 -7.208,2.751 -9.961,0 -2.068,-2.07 -2.58,-5.11 -1.531,-7.658 l -9.5,-9.499 v 24.997 c 0.67,0.332 1.303,0.774 1.861,1.332 2.75,2.75 2.75,7.206 0,9.959 -2.75,2.749 -7.209,2.749 -9.957,0 -2.75,-2.754 -2.75,-7.21 0,- [...]
+ </g>
+ <g
+ transform="matrix(1.1836353,0,0,1.1836353,57.486934,57.295456)">
+ <polygon
+ style="fill:#3d6380"
+ points="18.2,32 18.2,18.2 32,18.2 32,13.8 18.2,13.8 18.2,0 13.8,0 13.8,13.8 0,13.8 0,18.2 13.8,18.2 13.8,32 "
+ />
+ </g>
+</svg>
\ No newline at end of file
diff --git a/docs/hop-user-manual/modules/ROOT/assets/images/icons/git-commit.svg b/docs/hop-user-manual/modules/ROOT/assets/images/icons/git-commit.svg
new file mode 100644
index 0000000..4a977d6
--- /dev/null
+++ b/docs/hop-user-manual/modules/ROOT/assets/images/icons/git-commit.svg
@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24">
+ <path fill-rule="evenodd"
+ d="M15.5 11.75a3.5 3.5 0 11-7 0 3.5 3.5 0 017 0zm1.444-.75a5.001 5.001 0 00-9.888 0H2.75a.75.75 0 100 1.5h4.306a5.001 5.001 0 009.888 0h4.306a.75.75 0 100-1.5h-4.306z"/>
+</svg>
\ No newline at end of file
diff --git a/docs/hop-user-manual/modules/ROOT/assets/images/icons/git-info.svg b/docs/hop-user-manual/modules/ROOT/assets/images/icons/git-info.svg
new file mode 100644
index 0000000..ccf5fbd
--- /dev/null
+++ b/docs/hop-user-manual/modules/ROOT/assets/images/icons/git-info.svg
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+ xmlns="http://www.w3.org/2000/svg"
+ version="1.1"
+ x="0px"
+ y="0px"
+ width="97px"
+ height="97px"
+ viewBox="0 0 97 97"
+ enable-background="new 0 0 97 97">
+ <path
+ fill="#F05133"
+ d="M92.71,44.408L52.591,4.291c-2.31-2.311-6.057-2.311-8.369,0l-8.33,8.332L46.459,23.19 c2.456-0.83,5.272-0.273,7.229,1.685c1.969,1.97,2.521,4.81,1.67,7.275l10.186,10.185c2.465-0.85,5.307-0.3,7.275,1.671 c2.75,2.75,2.75,7.206,0,9.958c-2.752,2.751-7.208,2.751-9.961,0c-2.068-2.07-2.58-5.11-1.531-7.658l-9.5-9.499v24.997 c0.67,0.332,1.303,0.774,1.861,1.332c2.75,2.75,2.75,7.206,0,9.959c-2.75,2.749-7.209,2.749-9.957,0c-2.75-2.754-2.75-7.21,0-9.959 c0.68-0.679,1.467-1.193,2.3 [...]
+ <g
+ transform="matrix(1.5008466,0,0,1.5008466,-47.384225,-47.353098)"
+ >
+ <circle
+ style="fill:#005ca7;fill-opacity:1;stroke-width:2.19102311;stroke-linecap:round;stroke-linejoin:round"
+ cx="80.112579"
+ cy="80.05043"
+ r="14.495687"
+ />
+ <path
+ d="m 78.524952,72.286843 v -1.797157 h 1.888673 1.888677 V 72.286843 74.084 h -1.888677 -1.888673 z"
+ style="fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:0.05088682;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;paint-order:markers fill stroke"
+ />
+ <path
+ style="fill:#ffffff;stroke-width:0.01490374;stroke-linecap:round;stroke-linejoin:round"
+ d="m 76.720625,89.212664 c -0.120851,-0.03767 -0.250079,-0.176448 -0.284522,-0.30558 -0.01735,-0.06484 -0.02933,-0.684526 -0.02943,-1.514694 -1.64e-4,-1.396007 2.61e-4,-1.405823 0.06649,-1.541903 0.12688,-0.26073 0.125634,-0.260472 1.318165,-0.270961 l 1.044165,-0.0093 v -2.525944 -2.526 l -1.044169,-0.01218 c -0.898646,-0.01058 -1.063189,-0.01955 -1.180616,-0.06549 -0.148659,-0.05817 -0.313968,-0.207814 -0.35561,-0.321891 -0.0145,-0.03966 -0.02634,-0.700195 -0.02634,-1.4 [...]
+ />
+ </g>
+</svg>
diff --git a/docs/hop-user-manual/modules/ROOT/assets/images/icons/git-revert.svg b/docs/hop-user-manual/modules/ROOT/assets/images/icons/git-revert.svg
new file mode 100644
index 0000000..27a9c4f
--- /dev/null
+++ b/docs/hop-user-manual/modules/ROOT/assets/images/icons/git-revert.svg
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+ xmlns="http://www.w3.org/2000/svg"
+ version="1.1"
+ x="0px"
+ y="0px"
+ width="97px"
+ height="97px"
+ viewBox="0 0 97 97"
+ enable-background="new 0 0 97 97">
+ <g
+ transform="matrix(0.84298576,0,0,0.84298576,0.40113214,0.40160318)">
+ <path
+ d="M 92.71,44.408 52.591,4.291 c -2.31,-2.311 -6.057,-2.311 -8.369,0 l -8.33,8.332 10.567,10.567 c 2.456,-0.83 5.272,-0.273 7.229,1.685 1.969,1.97 2.521,4.81 1.67,7.275 l 10.186,10.185 c 2.465,-0.85 5.307,-0.3 7.275,1.671 2.75,2.75 2.75,7.206 0,9.958 -2.752,2.751 -7.208,2.751 -9.961,0 -2.068,-2.07 -2.58,-5.11 -1.531,-7.658 l -9.5,-9.499 v 24.997 c 0.67,0.332 1.303,0.774 1.861,1.332 2.75,2.75 2.75,7.206 0,9.959 -2.75,2.749 -7.209,2.749 -9.957,0 -2.75,-2.754 -2.75,-7.21 0,- [...]
+ style="fill:#f05133"/>
+ </g>
+ <path
+ style="fill:#0e3a5a;fill-opacity:1;stroke-width:0.09796388"
+ d="m 71.997331,62.049674 c -7.290474,0 -13.742375,3.516119 -17.8069,8.930389 L 46.74733,63.535296 v 23.767021 h 23.767022 l -8.085939,-8.084961 c 2.148445,-6.516559 8.275011,-11.224703 15.510621,-11.224703 9.028354,0 16.3394,7.316924 16.3394,16.340376 9e-6,-12.307204 -9.974684,-22.281887 -22.279929,-22.281887"/>
+</svg>
diff --git a/docs/hop-user-manual/modules/ROOT/assets/images/icons/pull.svg b/docs/hop-user-manual/modules/ROOT/assets/images/icons/pull.svg
new file mode 100644
index 0000000..ee81d5e
--- /dev/null
+++ b/docs/hop-user-manual/modules/ROOT/assets/images/icons/pull.svg
@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+ xmlns="http://www.w3.org/2000/svg"
+ version="1.1"
+ x="0px"
+ y="0px"
+ viewBox="0 0 16 16"
+ enable-background="new 0 0 16 16"
+ width="16px"
+ height="16px">
+
+ <path
+ style="fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:0.1;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+ d="M 7.2520744,13.500129 C 6.2215758,13.369148 5.2275352,12.966356 4.385935,12.338748 4.0576504,12.093936 3.5337103,11.583871 3.2703876,11.252742 2.6134945,10.426698 2.1927259,9.4472987 2.0276724,8.3601453 1.9738491,8.0056289 1.9672005,7.1504144 2.0155979,6.8069866 2.2102558,5.4256925 2.774956,4.2778047 3.7323713,3.3172353 4.6113294,2.4353817 5.7412982,1.8461529 6.9745328,1.6265913 7.3368909,1.5620782 8.1678971,1.5370601 8.586611,1.5780585 c 1.3036706,0.127649 2.60192,0.74178 [...]
+ />
+ <g
+ >
+ <rect
+ style="fill:#3d6380;fill-opacity:1;stroke:none;stroke-width:1;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+ width="2"
+ height="9"
+ x="7.0023136"
+ y="3.0413868"/>
+ <rect
+ y="-3.3942273"
+ x="12.882042"
+ height="7"
+ width="2"
+ style="fill:#3d6380;fill-opacity:1;stroke:none;stroke-width:1;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+ transform="matrix(0.70710678,0.70710678,-0.70710678,0.70710678,0,0)"/>
+ <rect
+ transform="matrix(0.70710678,-0.70710678,0.70710678,0.70710678,0,0)"
+ style="fill:#3d6380;fill-opacity:1;stroke:none;stroke-width:1;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+ width="2"
+ height="7"
+ x="-3.6078215"
+ y="7.879992"/>
+ </g>
+ <path
+ style="fill:#3d6380;fill-opacity:1;stroke:none;stroke-width:0.00246533;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+ d="m 7.5441661,15.966407 c -0.6216,-0.05018 -1.038198,-0.116232 -1.524847,-0.241774 C 3.3003561,15.023216 1.1197462,12.912613 0.33223061,10.220124 0.22211211,9.8436326 0.12944601,9.4041086 0.06949211,8.9739319 0.01622401,8.5917274 0.00915891,7.4913566 0.05750801,7.1074629 0.25307911,5.5546212 0.81514121,4.2100268 1.7733704,3.0026863 2.017993,2.6944691 2.5393881,2.1595411 2.8477105,1.9004612 3.8549591,1.0540816 5.0160191,0.47446383 6.2687261,0.19264003 c 0.630697,-0.1418891 0. [...]
+ />
+</svg>
\ No newline at end of file
diff --git a/docs/hop-user-manual/modules/ROOT/assets/images/icons/push.svg b/docs/hop-user-manual/modules/ROOT/assets/images/icons/push.svg
new file mode 100644
index 0000000..c535749
--- /dev/null
+++ b/docs/hop-user-manual/modules/ROOT/assets/images/icons/push.svg
@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+ xmlns="http://www.w3.org/2000/svg"
+ version="1.1"
+ x="0px"
+ y="0px"
+ viewBox="0 0 16 16"
+ enable-background="new 0 0 16 16"
+ width="16px"
+ height="16px">
+ <path
+ style="fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:0.1;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+ d="M 7.2520744,13.500129 C 6.2215758,13.369148 5.2275352,12.966356 4.385935,12.338748 4.0576504,12.093936 3.5337103,11.583871 3.2703876,11.252742 2.6134945,10.426698 2.1927259,9.4472987 2.0276724,8.3601453 1.9738491,8.0056289 1.9672005,7.1504144 2.0155979,6.8069866 2.2102558,5.4256925 2.774956,4.2778047 3.7323713,3.3172353 4.6113294,2.4353817 5.7412982,1.8461529 6.9745328,1.6265913 7.3368909,1.5620782 8.1678971,1.5370601 8.586611,1.5780585 c 1.3036706,0.127649 2.60192,0.74178 [...]
+ />
+ <g
+ transform="matrix(1,0,0,-1,0,16.114246)"
+ >
+ <rect
+ style="fill:#3d6380;fill-opacity:1;stroke:none;stroke-width:1;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+ width="2"
+ height="9"
+ x="7.0023136"
+ y="3.0413868"/>
+ <rect
+ y="-3.3942273"
+ x="12.882042"
+ height="7"
+ width="2"
+ style="fill:#3d6380;fill-opacity:1;stroke:none;stroke-width:1;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+ transform="matrix(0.70710678,0.70710678,-0.70710678,0.70710678,0,0)"/>
+ <rect
+ transform="matrix(0.70710678,-0.70710678,0.70710678,0.70710678,0,0)"
+ style="fill:#3d6380;fill-opacity:1;stroke:none;stroke-width:1;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+ width="2"
+ height="7"
+ x="-3.6078215"
+ y="7.879992"/>
+ </g>
+ <path
+ style="fill:#3d6380;fill-opacity:1;stroke:none;stroke-width:0.00246533;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+ d="m 7.5441661,15.966407 c -0.6216,-0.05018 -1.038198,-0.116232 -1.524847,-0.241774 C 3.3003561,15.023216 1.1197462,12.912613 0.33223061,10.220124 0.22211211,9.8436326 0.12944601,9.4041086 0.06949211,8.9739319 0.01622401,8.5917274 0.00915891,7.4913566 0.05750801,7.1074629 0.25307911,5.5546212 0.81514121,4.2100268 1.7733704,3.0026863 2.017993,2.6944691 2.5393881,2.1595411 2.8477105,1.9004612 3.8549591,1.0540816 5.0160191,0.47446383 6.2687261,0.19264003 c 0.630697,-0.1418891 0. [...]
+ />
+</svg>
\ No newline at end of file
diff --git a/docs/hop-user-manual/modules/ROOT/assets/images/icons/rename.svg b/docs/hop-user-manual/modules/ROOT/assets/images/icons/rename.svg
new file mode 100644
index 0000000..d2e362b
--- /dev/null
+++ b/docs/hop-user-manual/modules/ROOT/assets/images/icons/rename.svg
@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<svg
+ version="1.1"
+ xmlns="http://www.w3.org/2000/svg"
+ x="0px"
+ y="0px"
+ width="24px"
+ height="24px"
+ viewBox="0 0 24 24"
+ enable-background="new 0 0 24 24"
+ xml:space="preserve">
+<path fill="#0E3A5A" d="M17,7h5v10h-5v2c0,0.553,0.447,1,1,1h2v2h-2.5c-0.55,0-1.5-0.45-1.5-1c0,0.55-0.95,1-1.5,1H12v-2h2
+ c0.553,0,1-0.447,1-1V5c0-0.552-0.447-1-1-1h-2V2h2.5C15.05,2,16,2.45,16,3c0-0.55,0.95-1,1.5-1H20v2h-2c-0.553,0-1,0.448-1,1V7
+ M2,7h11v2H4v6h9v2H2V7 M20,15V9h-3v6H20z"/>
+</svg>
diff --git a/docs/hop-user-manual/modules/ROOT/pages/hop-gui/hop-gui-git.adoc b/docs/hop-user-manual/modules/ROOT/pages/hop-gui/hop-gui-git.adoc
index ae9077e..1458704 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/hop-gui/hop-gui-git.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/hop-gui/hop-gui-git.adoc
@@ -15,7 +15,7 @@ specific language governing permissions and limitations
under the License.
////
:imagesdir: ../../assets/images
-:description: Managing your work in version control is crucial in serious Hop projects. Hop's file explorer perspective offers the basic functionality to manage your work in git: pull, push, visual diff, commit etc are all available from a user friendly ui.
+:description: Version control is an important aspect of any serious data orchestration project.. Hop's file explorer perspective offers the basic functionality to manage your work in git: pull, push, visual diff, commit etc are all available from a user friendly ui.
= Working with git
@@ -24,25 +24,34 @@ Hop wants to make it as easy as possible to manage versions for your workflows a
== File Explorer Toolbar
-The toolbar in the file explorer's tree dialog will enable the git options when it detects the project's root directory is a git repository (has a `.git` folder).
+If you open the file explorer for a project that is not version controlled in git, the git icons in the file explorer's main toolbar (top left) will be shown as greyed-out and disabled.
-image::hop-gui/hop-gui-no-git.png[No git available,width="30%"]
+image::hop-gui/hop-gui-no-git.png[No git available,width="50%"]
-If git was found, the toolbar will be shown with the git options enabled.
+If git was found (ie the project has a `.git` folder in the project root), these buttons in this toolbar are enabled.
-image::hop-gui/hop-gui-git-toolbar.png[Git toolbar,width="30%"]
+image::hop-gui/hop-gui-git-toolbar.png[Git toolbar,width="50%"]
-The options available in this toolbar are:
+The available options to work with files and the available git operations in this toolbar are briefly discussed below.
+
+[options="header", width="90%", cols="1,2,5,1"]
+|===
+|icon|action|description|shortcut
+|image:icons/arrow-right.svg[width="24px"]|Open selected file|Opens the selected file in the appropriate editor (pipeline or workflow editor for workflows and pipelines, text editor for other files|double-click
+|image:icons/folder-add.svg[width="24px"]|Add folder|adds a new folder at the selected location. A popup is shown for the folder name|
+|image:icons/delete.svg[width="24px"]|Delete Selected File|Deletes the selected file|DEL
+|image:icons/rename.svg[width="24px"]|Rename the selected file|Makes the selected file name editable to allow renaming|F2
+|image:icons/refresh.svg[width="24px"]|Refresh|Refreshes the projects folder and file structure|
+|image:icons/git-info.svg[width="24px"]|Git info|Populates the file explorer's git dialog with version information for the selected file.|
+|image:icons/git-add.svg[width="24px"]|Git Add|Add the selected file to version control|
+|image:icons/git-revert.svg[width="24px"]|Git Revert|Revert file to last committed version (HEAD)|
+|image:icons/git-commit.svg[width="24px"]|Git commit|Commit the latest changes for the selected file (providing a commit message)|
+|image:icons/push.svg[width="24px"]|Git push|Push the recent changes to the remote repository|
+|image:icons/pull.svg[width="24px"]|Git pull|Pull the latest changes from the remote repository|
+|===
+
+NOTE: Only the available options are availabe at a given time. E.g. `git add` will not be available for files that already are in version control.
-* Open selected file
-* Delete Selected File
-* Refresh
-* Git info
-* Git Add
-* Git revert file to last committed version (HEAD)
-* Git commit
-* Git push
-* Git pull
== File Explorer Tree