Skip to content

Commit

Permalink
chore: regenerated plugin docs
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Apr 19, 2022
1 parent 7f4e573 commit 4e30707
Show file tree
Hide file tree
Showing 8 changed files with 318 additions and 1 deletion.
30 changes: 30 additions & 0 deletions content/en/v3/develop/reference/jx/scm/pull-request/_index.md
@@ -0,0 +1,30 @@
---
title: jx scm pull-request
linktitle: pull-request
type: docs
description: "Commands for working with pull-requests ***Aliases**: pr*"
aliases:
- jx-scm_pull-request
---

### Usage

```
jx scm pull-request
```

### Synopsis

Commands for working with pull-requests

### Options

```
-h, --help help for pull-request
```



### Source

[jenkins-x-plugins/jx-scm](https://github.com/jenkins-x-plugins/jx-scm)
@@ -0,0 +1,49 @@
---
title: jx scm pull-request close
linktitle: close
type: docs
description: "closes a pull request"
aliases:
- jx-scm_pull-request_close
---

### Usage

```
jx scm pull-request close
```

### Synopsis

Update a release

### Examples

```bash
# closes pull requests foo/bar number 123
jx-scm pull-request close --owner foo --name bar --pr 123

# closes all open pull requests on foo/bar before pull request number 200
jx-scm pull-request close --owner foo --name bar --before 200

```
### Options

```
--before int a pull request number to used to close ALL open pull requests before it
-h, --help help for close
-k, --kind string the kind of git server to use
-r, --name string the name of the repository that contains pull requests to close
-o, --owner string the owner of the repository that contains pull requests to close. Either an organisation or username
--pr int the pull request to close
-s, --server string the git server URL to use
--size int the number of open pull requests to return if using --before, defaults to 200 (default 200)
-t, --token string the token to use on the git server
-u, --username string the user name to use on the git server
```



### Source

[jenkins-x-plugins/jx-scm](https://github.com/jenkins-x-plugins/jx-scm)
@@ -0,0 +1,53 @@
---
title: jx scm pull-request create
linktitle: create
type: docs
description: "Creates a pull request"
aliases:
- jx-scm_pull-request_create
---

### Usage

```
jx scm pull-request create
```

### Synopsis

Creates a pull request in the given repository, requesting the head branch be merged into the base branch

### Examples

```bash
# creates a pull request for a branch
jx-scm pull-request create \
--owner foo \
--name bar \
--title "chore: a good reason to merge" \
--body "Useful details for reviewers" \
--head some-feature-branch \
--base main

```
### Options

```
--base string the name of the branch you want the changes pulled into (default "main")
--body string the contents of the pull request
--head string the name of the branch where your changes are implemented
-h, --help help for create
-k, --kind string the kind of git server to use
-r, --name string the name of the repository
-o, --owner string the owner of the repository. Either an organisation or username
-s, --server string the git server URL to use
--title string the title of the new pull request
-t, --token string the token to use on the git server
-u, --username string the user name to use on the git server
```



### Source

[jenkins-x-plugins/jx-scm](https://github.com/jenkins-x-plugins/jx-scm)
30 changes: 30 additions & 0 deletions content/en/v3/develop/reference/jx/scm/release/_index.md
@@ -0,0 +1,30 @@
---
title: jx scm release
linktitle: release
type: docs
description: "Commands for working with releases ***Aliases**: release*"
aliases:
- jx-scm_release
---

### Usage

```
jx scm release
```

### Synopsis

Commands for working with releases

### Options

```
-h, --help help for release
```



### Source

[jenkins-x-plugins/jx-scm](https://github.com/jenkins-x-plugins/jx-scm)
50 changes: 50 additions & 0 deletions content/en/v3/develop/reference/jx/scm/release/update/_index.md
@@ -0,0 +1,50 @@
---
title: jx scm release update
linktitle: update
type: docs
description: "Updates a release"
aliases:
- jx-scm_release_update
---

### Usage

```
jx scm release update
```

### Synopsis

Update a release

### Examples

```bash
# updates a release to change the title
jx-scm release update --owner foo --repository bar --tag v1.2.3 --title something

# updates a release to make it not a pre-release
jx-scm release update --owner foo --repository bar --tag v1.2.3 --pre-release false

```
### Options

```
--description string the updated release description
-h, --help help for update
-k, --kind string the kind of git server to use
-r, --name string the name of the repository to update
-o, --owner string the owner of the repository to update. Either an organisation or username
--prerelease the updated prerelease status, true to identify the release as a prerelease, false to identify the release as a full release. (default true)
-s, --server string the git server URL to use
--tag string the tag of the release to update
--title string the updated release title
-t, --token string the token to use on the git server
-u, --username string the user name to use on the git server
```



### Source

[jenkins-x-plugins/jx-scm](https://github.com/jenkins-x-plugins/jx-scm)
40 changes: 40 additions & 0 deletions content/en/v3/develop/reference/jx/scm/repository/clone/_index.md
@@ -0,0 +1,40 @@
---
title: jx scm repository clone
linktitle: clone
type: docs
description: "Clones a git repository"
aliases:
- jx-scm_repository_clone
---

### Usage

```
jx scm repository clone
```

### Synopsis

Clones a git repository

### Examples

```bash
# creates a new git repository in the given server
jx-scm repository clone https://myserver.com/myowner/myrepo

```
### Options

```
-b, --batch-mode Runs in batch mode without prompting for user input
-h, --help help for clone
--log-level string Sets the logging level. If not specified defaults to $JX_LOG_LEVEL
--verbose Enables verbose output. The environment variable JX_LOG_LEVEL has precedence over this flag and allows setting the logging level to any value of: panic, fatal, error, warn, info, debug, trace
```



### Source

[jenkins-x-plugins/jx-scm](https://github.com/jenkins-x-plugins/jx-scm)
Expand Up @@ -21,22 +21,31 @@ Creates a new git provider in a git server

```bash
# creates a new git repository in the given server
jx-scm repository create --git-kind gitlab --git-server https://myserver.com --owner myuser --name myrepo%!(EXTRA string=jx-scm)
jx-scm repository create --git-kind gitlab --git-server https://myserver.com --owner myuser --name myrepo

# creates a new git repository using a URL
jx-scm repository create --git-kind gitlab https://mygitserver/myowner/myrepo

```
### Options

```
-b, --batch-mode Runs in batch mode without prompting for user input
--confirm confirms creating the repository
-d, --description string the repository description
-h, --help help for create
--home-page string the repository home page
-k, --kind string the kind of git server to use
--log-level string Sets the logging level. If not specified defaults to $JX_LOG_LEVEL
-n, --name string the name of the repository to create
-o, --owner string the owner of the repository to create. Either an organisation or username
--private if the repository should be private
--push-host string the git host to use when pushing to the git repository. Only really useful in BDD tests if using something like 'kubectl portforward' to access a git repository where you want to push from outside the cluster with a different host name to the host name used inside the cluster
-s, --server string the git server URL to use
--template string the git template repository to create the repository from
-t, --token string the token to use on the git server
-u, --username string the user name to use on the git server
--verbose Enables verbose output. The environment variable JX_LOG_LEVEL has precedence over this flag and allows setting the logging level to any value of: panic, fatal, error, warn, info, debug, trace
```


Expand Down
56 changes: 56 additions & 0 deletions content/en/v3/develop/reference/jx/scm/repository/remove/_index.md
@@ -0,0 +1,56 @@
---
title: jx scm repository remove
linktitle: remove
type: docs
description: "Removes one or more repositories ***Aliases**: delete,rm*"
aliases:
- jx-scm_repository_remove
---

### Usage

```
jx scm repository remove
```

### Synopsis

Removes one or more repositories

### Examples

```bash
# removes all the repositories in the owner with the given filter
jx-scm repository remove --owner myuser -f mything

# removes all the repositories in the owner created before the given time
jx-scm repository remove --owner myuser --created-before '02 Jan 06 15:04 MST'

# removes all the repositories in the owner created 30 days ago
jx-scm repository remove --owner myuser --created-days-ago 30 --confirm

```
### Options

```
--confirm confirms the removal without prompting the user
--created-before string the time expression for removing repositories created before this time
--created-days-ago int remove repositories created more than this number of days ago
--dry-run disables actually deleting the repository so you can test the filtering
-x, --exclude stringArray the text filter to exclude
--fail-on-error stops removing repositories if a remove failsg
-f, --filter stringArray the text filter to match the name
--git-kind string the kind of git server to connect to
--git-server string the git server URL to create the scm client
--git-token string the git token used to operate on the git repository. If not specified it's loaded from the git credentials file
--git-username string the git username used to operate on the git repository. If not specified it's loaded from the git credentials file
-h, --help help for remove
-n, --name string the name of the repository to create
-o, --owner string the owner of the repository to create. Either an organisation or username
```



### Source

[jenkins-x-plugins/jx-scm](https://github.com/jenkins-x-plugins/jx-scm)

0 comments on commit 4e30707

Please sign in to comment.