Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarifying fields #30

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Clarifying fields #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
799b4ec
formatting markdown
jsboak Feb 2, 2024
a7ed1c0
fix error message and cleanup readme
jsboak Feb 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .DS_Store
View file
Open in desktop
Binary file not shown.
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ If `yes`, require remote host SSH key is defined in the `~/.ssh/known_hosts` fil
### Limitations

* The plugin needs to clone the full repo on the local directory path (Base Directory option) to get the file that will be added to the resource model.
* Any time that you edit the nodes on the GUI, the commit will be perfomed with the message `Edit node from GUI` (it is not editable)
* Any time that you edit the nodes on the GUI, the commit will be performed with the message `Edit node from GUI` (it is not editable)

## Workflow Steps

Expand All @@ -78,13 +78,13 @@ This plugin can clone/pull, add, commit, and push a git repository via 4 Workflo
* `ssh://[user@]host.xz[:port]/path/to/repo.git/`
* `git://host.xz[:port]/path/to/repo.git/`
* `http[s]://host.xz[:port]/path/to/repo.git/`
* `https[s]://[email protected]/account/repo.git`
* `ftp[s]://host.xz[:port]/path/to/repo.git/`
* `rsync://host.xz/path/to/repo.git/`


##### Authentication

* **Password Storage Path**: Password storage path to authenticate remotely
* **Password Storage Path**: Password storage path to authenticate remotely. This can be an Access Token - such as a Github access token.
* **SSH: Strict Host Key Checking**: Use strict host key checking.
If `yes`, require remote host SSH key is defined in the `~/.ssh/known_hosts` file, otherwise do not verify.
* **SSH Key Storage Path**: SSH Key storage path to authenticate
Expand Down
8 changes: 4 additions & 4 deletions build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
plugins {
id 'pl.allegro.tech.build.axion-release' version '1.15.4'
id 'pl.allegro.tech.build.axion-release' version '1.16.1'
}

group 'com.rundeck'
Expand Down Expand Up @@ -36,12 +36,12 @@ configurations {

dependencies {
implementation 'org.codehaus.groovy:groovy-all:3.0.9'
testImplementation group: 'junit', name: 'junit', version: '4.12'
testImplementation group: 'junit', name: 'junit', version: '4.13.1'

implementation group: 'org.rundeck', name: 'rundeck-core', version: '4.15.0-20230725'
implementation group: 'org.rundeck', name: 'rundeck-core', version: '5.1.0-rc2-20240124'
implementation 'org.slf4j:slf4j-api:1.7.30'

pluginLibs( 'org.eclipse.jgit:org.eclipse.jgit:5.13.2.202306221912-r') {
pluginLibs('org.eclipse.jgit:org.eclipse.jgit:6.6.1.202309021850-r') {
exclude module: 'slf4j-api'
exclude module: 'jsch'
exclude module: 'commons-logging'
Expand Down
Binary file added images/.DS_Store
View file
Open in desktop
Binary file not shown.
Binary file modified images/clone-workflow-step.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/.DS_Store
View file
Open in desktop
Binary file not shown.
2 changes: 1 addition & 1 deletion src/main/groovy/com/rundeck/plugin/GitAddWorkflowStep.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ class GitAddWorkflowStep implements StepPlugin, Describable{
PropertyUtil.string(GIT_BASE_DIRECTORY, "Base Directory", "Directory to add to.", true,
null, null, null, renderingOptionsConfig))
.property(PropertyUtil.string(GIT_ADD_FILE_PATTERN, "File Pattern", '''File Pattern of files to be added.
See [addFilepattern](http://archive.eclipse.org/jgit/docs/jgit-2.0.0.201206130900-r/apidocs/org/eclipse/jgit/api/AddCommand.html#addFilepattern(java.lang.String)) for more details.''', true,
See [addFilepattern](http://archive.eclipse.org/jgit/docs/jgit-2.0.0.201206130900-r/apidocs/org/eclipse/jgit/api/AddCommand.html#addFilepattern(java.lang.String)) for more details.''', true,
".",null,null, renderingOptionsConfig))
.property(PropertyUtil.bool(GIT_LOG_DISABLE, "Disable log output", "Enabling this flag, the plugin will not show the output log", true,
"false",null, renderingOptionsConfig))
Expand Down
18 changes: 9 additions & 9 deletions src/main/groovy/com/rundeck/plugin/GitCloneWorkflowStep.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,14 +52,14 @@ class GitCloneWorkflowStep implements StepPlugin, Describable{
PropertyUtil.string(GIT_BASE_DIRECTORY, "Base Directory", "Directory for checkout.", true,
null, null, null, renderingOptionsConfig))
.property(PropertyUtil.string(GIT_URL, "Git URL", '''Checkout url.
See [git-clone](https://www.kernel.org/pub/software/scm/git/docs/git-clone.html)
specifically the [GIT URLS](https://www.kernel.org/pub/software/scm/git/docs/git-clone.html#URLS) section.
Some examples:
* `ssh://[user@]host.xz[:port]/path/to/repo.git/`
* `git://host.xz[:port]/path/to/repo.git/`
* `http[s]://host.xz[:port]/path/to/repo.git/`
* `ftp[s]://host.xz[:port]/path/to/repo.git/`
* `rsync://host.xz/path/to/repo.git/`''', true,
See [git-clone](https://www.kernel.org/pub/software/scm/git/docs/git-clone.html)
specifically the [GIT URLS](https://www.kernel.org/pub/software/scm/git/docs/git-clone.html#URLS) section.
Some examples:
* `ssh://[user@]host.xz[:port]/path/to/repo.git/`
* `git://host.xz[:port]/path/to/repo.git/`
* `http[s]://host.xz[:port]/path/to/repo.git/`
* `ftp[s]://host.xz[:port]/path/to/repo.git/`
* `rsync://host.xz/path/to/repo.git/`''', true,
null,null,null, renderingOptionsConfig))
.property(PropertyUtil.string(GIT_BRANCH, "Branch", "Checkout branch.", true,
"master",null,null, renderingOptionsConfig))
Expand Down Expand Up @@ -139,7 +139,7 @@ If `yes`, require remote host SSH key is defined in the `~/.ssh/known_hosts` fil

}catch(Exception e){
logger.log(0, e.getMessage())
throw new StepException("Error ${op} VM.", GitFailureReason.AuthenticationError)
throw new StepException("Error with Authentication ${e.getMessage()}", GitFailureReason.AuthenticationError)

}

Expand Down
16 changes: 8 additions & 8 deletions src/main/groovy/com/rundeck/plugin/GitCommitWorkflowStep.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,14 @@ class GitCommitWorkflowStep implements StepPlugin, Describable{
PropertyUtil.string(GIT_BASE_DIRECTORY, "Base Directory", "Directory to commit.", true,
null, null, null, renderingOptionsConfig))
.property(PropertyUtil.string(GIT_URL, "Git URL", '''Checkout url.
See [git-commit](https://www.kernel.org/pub/software/scm/git/docs/git-commit.html)
specifically the [GIT URLS](https://www.kernel.org/pub/software/scm/git/docs/git-push.html#URLS) section.
Some examples:
* `ssh://[user@]host.xz[:port]/path/to/repo.git/`
* `git://host.xz[:port]/path/to/repo.git/`
* `http[s]://host.xz[:port]/path/to/repo.git/`
* `ftp[s]://host.xz[:port]/path/to/repo.git/`
* `rsync://host.xz/path/to/repo.git/`''', true,
See [git-commit](https://www.kernel.org/pub/software/scm/git/docs/git-commit.html)
specifically the [GIT URLS](https://www.kernel.org/pub/software/scm/git/docs/git-push.html#URLS) section.
Some examples:
* `ssh://[user@]host.xz[:port]/path/to/repo.git/`
* `git://host.xz[:port]/path/to/repo.git/`
* `http[s]://host.xz[:port]/path/to/repo.git/`
* `ftp[s]://host.xz[:port]/path/to/repo.git/`
* `rsync://host.xz/path/to/repo.git/`''', true,
null,null,null, renderingOptionsConfig))
.property(PropertyUtil.string(GIT_MESSAGE, "Message", "Commit Message.", true,
"Rundeck Commit",null,null, renderingOptionsConfig))
Expand Down
16 changes: 8 additions & 8 deletions src/main/groovy/com/rundeck/plugin/GitPushWorkflowStep.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,14 +51,14 @@ class GitPushWorkflowStep implements StepPlugin, Describable{
PropertyUtil.string(GIT_BASE_DIRECTORY, "Base Directory", "Directory to push.", true,
null, null, null, renderingOptionsConfig))
.property(PropertyUtil.string(GIT_URL, "Git URL", '''Checkout url.
See [git-push](https://www.kernel.org/pub/software/scm/git/docs/git-push.html)
specifically the [GIT URLS](https://www.kernel.org/pub/software/scm/git/docs/git-push.html#URLS) section.
Some examples:
* `ssh://[user@]host.xz[:port]/path/to/repo.git/`
* `git://host.xz[:port]/path/to/repo.git/`
* `http[s]://host.xz[:port]/path/to/repo.git/`
* `ftp[s]://host.xz[:port]/path/to/repo.git/`
* `rsync://host.xz/path/to/repo.git/`''', true,
See [git-push](https://www.kernel.org/pub/software/scm/git/docs/git-push.html)
specifically the [GIT URLS](https://www.kernel.org/pub/software/scm/git/docs/git-push.html#URLS) section.
Some examples:
* `ssh://[user@]host.xz[:port]/path/to/repo.git/`
* `git://host.xz[:port]/path/to/repo.git/`
* `http[s]://host.xz[:port]/path/to/repo.git/`
* `ftp[s]://host.xz[:port]/path/to/repo.git/`
* `rsync://host.xz/path/to/repo.git/`''', true,
null,null,null, renderingOptionsConfig))
.property(PropertyUtil.bool(GIT_LOG_DISABLE, "Disable log output", "Enabling this flag, the plugin will not show the output log", true,
"false",null, renderingOptionsConfig))
Expand Down
Loading