# Content-Replace-Plugin

**Repository Path**: mirrors/Content-Replace-Plugin

## Basic Information

- **Project Name**: Content-Replace-Plugin
- **Description**: Content Replace Plugin 作为一个 Jenkins 插件，用于构建过程中对一些文本文件内容的修改替换
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 4
- **Forks**: 1
- **Created**: 2019-06-21
- **Last Updated**: 2023-09-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Content-replace plugin for Jenkins
=========================

[![](https://img.shields.io/jenkins/plugin/v/content-replace.svg)](https://plugins.jenkins.io/content-replace)
[![](https://img.shields.io/github/release/jenkinsci/content-replace.svg?label=changelog)](https://github.com/jenkinsci/content-replace/releases/latest)
[![](https://img.shields.io/jenkins/plugin/i/content-replace.svg?color=green)](https://plugins.jenkins.io/content-replace)
[![Build Status](https://ci.jenkins.io/job/Plugins/job/content-replace-plugin/job/master/badge/icon)](https://ci.jenkins.io/job/Plugins/job/content-replace-plugin/job/master/)


A plugin for Jenkins allows you to replace file content with regex
expressions.

  

## Features

-   Regex expression for search. e.g.
    (Version=)(\[0-9\]+\\.\[0-9\]+\\.\[0-9\]+)
-   You can use variables enclosed in ${}  

## Requirements

### Jenkins

Jenkins [version 2.204.6](https://jenkins.io/changelog#v2.204.6) or newer is
required.

  

#### Freestyle job configuration

![Freestyle](./doc/Freestyle-job-configuration.png)

#### Pipeline job configuration
```
contentReplace(
  configs: [
    fileContentReplaceConfig(
      configs: [
        fileContentReplaceItemConfig(
          search: '(Version=)([0-9]+\\.[0-9]+\\.[0-9]+)',
          replace: '$11.0.${BUILD_ID}',
          matchCount: 1,
          verbose: false,
        )
      ],
      fileEncoding: 'UTF-8',
      lineSeparator: 'Unix',
      filePath: 'versions.txt'
    )
  ]
)
```

## Changelog

### Version 1.8.2 (Aug 14, 2023)
-   Fixed, [JENKINS-71382] contentReplace 1.8.0 generates an empty file, 1.7.0 works ok

### Version 1.8.1 (Jun 25, 2023)
-   Fixed, configuration values echo in the interface
-   Fixed, Expected named arguments java error

### Version 1.8.0 (May 29, 2023)

-   Add, support "line separator" config
-   Fixed, [JENKINS-70550] Content Replace Plugin Eats Trailing Newlines

### Version 1.7.0 (Feb 04, 2022)

-   Add, support verbose output control

### Version 1.6.0 (Dec 19, 2020)

-   Update the required version of Jenkins to v2.204.6

### Version 1.5.0 (Jan 19, 2020)

-   Add, support filepath of Ant path style

### Version 1.4.0 (Jan 09, 2020)

-   Fixed, contentReplace does not appear in the Snippet Generator

### Version 1.3.0 (Dec 07, 2019)

-   enables RegEx multiline mode
-   print replace lines info
-   beautify log

### Version 1.2.0 (Nov 23, 2019)

-   Move docs to GitHub

### Version 1.1.0 (Nov 18, 2019)

-   New, make failure immediately

### Version 1.0.10 (Aug 20, 2019)

-   Fixed, match count

### Version 1.0.8 (Aug 09, 2019)

-   Fixed, close InputStream after read the file‘s content

### Version 1.0.7 (June 21, 2019)

-   Fixed, matchCount not to be reset to 1 When editing the
    configuration file again

### Version 1.0.5 (Apr 07, 2019)

-   Fixed, support windows slave, linux master

### Version 1.0.4 (Feb 21, 2019)

-   Fixed, support for absolute path file
-   Fixed, matchCount not to be reset to 1 When editing the
    configuration file again

### Version 1.0.3 (Feb 19, 2019)

-   "File path" can be configured using variables

### Version 1.0.2 (Oct 26, 2018)

-   Add "Match count" config

### Version 1.0.1 (Aug 22, 2018)

-   Simply replace the contents of the specified encoded file