image-tag-parameter-plugin: https://github.com/mamh-java/image-tag-parameter-plugin

代码拉取完成,页面将自动刷新

richgiteeai

Watch

不关注关注所有动态仅关注版本发行动态关注但不提醒动态

1 Star 0 Fork 0

mamh-java/image-tag-parameter-plugin

代码 Issues 0 Pull Requests 0 Wiki 统计流水线

服务

加入 Gitee

与超过 1400万开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)

免费加入

已有帐号? 立即登录

克隆/下载

HTTPS SSH SVN SVN+SSH 下载ZIP

提示

下载代码请复制以下命令到终端执行

为确保你提交的代码身份被 Gitee 正确识别,请执行以下命令完成配置

git config --global user.name userName 
git config --global user.email userEmail

初次使用 SSH 协议进行代码克隆、推送等操作时,需按下述提示完成 SSH 配置

1 生成 RSA 密钥

2 获取 RSA 公钥内容,并配置到 SSH公钥中

在 Gitee 上使用 SVN,请访问使用指南

使用 HTTPS 协议时,命令行会出现如下账号密码验证步骤。基于安全考虑,Gitee 建议配置并使用私人令牌替代登录密码进行克隆、推送等操作

Username for 'https://gitee.com': userName

Password for 'https://userName@gitee.com': # 私人令牌

新建文件新建 Diagram 文件

新建子模块

上传文件

分支 65

标签 18

贡献代码

同步代码

创建 Pull Request

了解更多

对比差异通过 Pull Request 同步

同步更新到分支

通过 Pull Request 同步

将会在向当前分支创建一个 Pull
Request,合入后将完成同步

dodo920306 [maven-release-plugin] prepare for next de... d48ad69

207 次提交

.github

img

src/main

testing

.editorconfig

.gitignore

CHANGELOG-old.md

CONTRIBUTING.md

Jenkinsfile

LICENSE

README.md

install_plugins.groovy

pom.xml

README

MIT

# Image Tag Parameter Plugin
![Logo](img/registry.png)

[Changelog](CHANGELOG-old.md)

[![Licence](https://img.shields.io/github/license/jenkinsci/image-tag-parameter-plugin.svg)](https://github.com/jenkinsci/image-tag-parameter-plugin/blob/master/LICENSE)
[![Build Status](https://ci.jenkins.io/job/Plugins/job/image-tag-parameter-plugin/job/master/badge/icon)](https://ci.jenkins.io/job/Plugins/job/image-tag-parameter-plugin/job/master/)
[![Contributors](https://img.shields.io/github/contributors/jenkinsci/image-tag-parameter-plugin.svg)](https://github.com/jenkinsci/image-tag-parameter-plugin/graphs/contributors)
[![Jenkins Plugin](https://img.shields.io/jenkins/plugin/v/image-tag-parameter.svg)](https://plugins.jenkins.io/image-tag-parameter)
[![GitHub release](https://img.shields.io/github/release/jenkinsci/image-tag-parameter-plugin.svg?label=changelog)](https://github.com/jenkinsci/image-tag-parameter-plugin/releases/latest)
[![Jenkins Plugin Installs](https://img.shields.io/jenkins/plugin/i/image-tag-parameter.svg?color=blue)](https://plugins.jenkins.io/image-tag-parameter)

## Introduction
This plugin allows you to define (container) image tags as parameter in your builds.
It uses the Docker **Registry HTTP API V2** to list tags available for an image.

## Screenshots
![Parameter Type Selection](img/screen01.png)

![Configuration](img/screen02.png)

![Image Selection](img/screen03.png)

![Global Configuration](img/jenkinsConfig.png)

## Usage

### Global Configuration

This Plugin allows a Jenkins admin to set a default registry in the Jenkins config, which will get used for any ImageTag parameter that does not overwrite the `registry` value in the parameter definition.
It is also possible (as of v1.8) to define a default credential, which should get used alongside of that default registry.
The default credential can be overwritten on a per parameter level just like the default registry.

#### JCasC (Jenkins Configuration as Code)

```yaml
unclassified:
# ...
 imageTagParameterConfiguration:
 defaultRegistry: "https://registry-1.docker.io"
 defaultCredentialId: ""
 defaultTagOrdering: DSC_VERSION
# ...
```

Configuring this plugins global config was available via JCasC since the addition of the global config in v1.2,
but the `defaultCredentialId` value can only be configured with a ImageTagParam version equal or newer to v1.8.

### Definition in Freestyle / Pipeline UI
This is basically showcased in the above [screenshots](#screenshots) :wink:

### Definition in Pipeline
```groovy
pipeline {
 agent any

parameters {
 imageTag(name: 'DOCKER_IMAGE', description: '',
 image: 'jenkins/jenkins', filter: 'lts.*', defaultTag: 'lts-jdk11',
 registry: 'https://registry-1.docker.io', credentialId: '', tagOrder: 'NATURAL')
 }

stages {
 stage('Test') {
 steps {
 echo "$DOCKER_IMAGE" // will print selected image name with tag (eg. jenkins/jenkins:lts-jdk11)
 echo "$DOCKER_IMAGE_TAG" // will print selected tag value (eg. lts-jdk11)
 echo "$DOCKER_IMAGE_IMAGE" // will print selected image name value (eg. jenkins/jenkins)
 }
 }
 }
}
```

**Required Values (Minimal Definition)**
```groovy
parameters {
 imageTag(name: 'DOCKER_IMAGE', image: 'jenkins/jenkins')
}
```

### Exposed Environment Variables (and params, since version 1.6)
Based on default Jenkins behaviour you can use `params.imageTagParameterName` to access the value of `imageName:imageTag`,
but since you most of the time only need the image tag by itself the plugin also exports some additional environment variables.

* **$imageTagParameterName_TAG** (or *env.imageTagParameterName_TAG*) contains only the tag value without the image name
* **$imageTagParameterName_IMAGE** (or *env.imageTagParameterName_IMAGE*) contains only the name of the image without the tag

### Set ImageTag Order (1.8+)

The order, of which the ImageTags are listed in the selector box, can be altered by the user via the parameter definition.
There are currently four options available:

* **NATURAL** or *Natural Ordering* ... this is the default setting and offers the same ordering as in the previous versions
* **REV_NATURAL** or *Reverse Natural Ordering* ... the reverted version of **NATURAL**
* **DSC_VERSION** or *Descending Versions* ... This will attempt to parse the gathered queried tags into `hudson.util.VersionNumber`
and order them descending.
* **ASC_VERSION** or *Ascending Versions* ... just like **DSC_VERSION** only in reverse (aka. ascending sorted)

**NOTE** The Version Ordering should be used with care and represents a convenience functionality, it will NOT work with every images tags or every configuration! \
The [`hudson.util.VersionNumber`](https://github.com/jenkinsci/lib-version-number/blob/master/src/main/java/hudson/util/VersionNumber.java)
may try to its best ability to parse a tag to a version, but as ImageTags don't require a format this might not yield an expected result,
so make sure to use a tag order that fits best for the tags you offer via a given job parameter.

## Contributing

Build instructions and requirements can be found in the [CONTRIBUTING](CONTRIBUTING.md) Markdown.

MIT License Copyright (c) 2019 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.