如何在Jenkins / Groovy中使用多行正则表达式匹配

huangapple
go评论150阅读模式
英文:

How do I use multiline regex match in Jenkins / Groovy

问题

In Jenkins，我正在构建一个步骤，该步骤读取CHANGELOG.md并使用正则表达式从给定版本中提取最新的更改日志。

用到的.groovy代码：

  1. def currentTag = '0.1.0'
  2. def changelogFileName = 'CHANGELOG.md'
  4. def changelogText = readFile(file: changelogFileName)
  5. def pattern = "(?s)^## ${currentTag}.*?(?=\\n\\n## |\\z)"
  6. def matcher = (changelogText =~ pattern)
  8. if (matcher.find()) {
  9.     def latestChangelog = matcher.group()
  10.     println(latestChangelog.strip())
  11. } else {
  12.     println('无法解析最新的更改日志。')
  13. }

用到的输入文件：

  1. # Changelog - 项目
  2. 所有显著的更改将在此文件中记录。
  3. 本项目遵循[语义化版本](http://semver.org/)。
  4. 根据[Keep a CHANGELOG](http://keepachangelog.com/)的准则编写的更改日志。
  6. ## 0.3.0 - 2022-06-30
  7. ### 更改:
  8. - MDN-XXXX: blabla
  9. ### 还有更改:
  10. - MDN-XXXX: blabla
  12. ## 0.2.0 - 2022-06-09
  13. ### 添加:
  14. - MDN-XXXX: blabla
  16. ## 0.1.1 - 2022-06-08
  17. ### 修复:
  18. - MDN-XXXX: blabla
  20. ## 0.1.0 - 2022-06-08
  21. ### 添加:
  22.  - MDN-XXXX: blabla
  23.  - MDN-XXXX: blabla

在本地，此代码运行得很好。
但是，我想在Jenkins中使用它，那里直接导入这些内容会存在安全问题：

  1. import java.nio.file.Files
  2. import java.nio.file.Paths
  3. import java.util.regex.Pattern

因此，我需要将其更改为适用于Jenkins的代码。

所以我将它更改为以下内容：

  1. def changelogText = readFile(file: changelogFileName)
  3. def pattern = "(?s)^## ${currentTag}.*?(?=\\n\\n## |\\z)"
  4. def matcher = (changelogText =~ pattern)
  6. if (matcher.find()) {
  7.     def latestChangelog = matcher.group()
  8.     println(latestChangelog.strip())
  9. } else {
  10.     println('无法解析最新的更改日志。')
  11. }

但是，我一直收到'无法解析最新的更改日志。'的消息。

当我不得不一直在Jenkins上运行它时，调试起来非常困难。
是否有人知道如何在本地使Jenkins库可用，或者更好的是，如何使用Pattern.MULTILINE进行匹配？

或者对于完全不同的方法是否有建议？

英文:

In Jenkins I'm building a step that reads CHANGELOG.md and uses regex to extract the latest changelog from giving version.

The used .groovy code:

  1. #!/usr/bin/env groovy
  3. import java.nio.file.Files
  4. import java.nio.file.Paths
  5. import java.util.regex.Pattern
  7. def String currentTag = '0.1.0';
  8. def String changelogFileName = 'CHANGELOG.md';
  10. def changelogText = new String(Files.readAllBytes(Paths.get(changelogFileName)))
  11. def pattern = Pattern.compile("(?s)^## ${currentTag}.*?(?=\n\n## |\\z)", Pattern.MULTILINE)
  12. def matcher = pattern.matcher(changelogText)
  14. if (matcher.find()) {
  15.     def latestChangelog = matcher.group()
  16.     println latestChangelog.strip()
  17. }

The used input file:

  1. # Changelog - Project
  2. All notable changes to this project will be documented in this file.
  3. This project adheres to [Semantic Versioning](http://semver.org/).
  4. Changelog based on guidelines from
  5. [Keep a CHANGELOG](http://keepachangelog.com/).
  7. ## 0.3.0 - 2022-06-30
  8. ### Changed:
  9. - MDN-XXXX: blabla
  10. ### Also Changed:
  11. - MDN-XXXX: blabla
  13. ## 0.2.0 - 2022-06-09
  14. ### Added:
  15. - MDN-XXXX: blabla
  17. ## 0.1.1 - 2022-06-08
  18. ### Fixed:
  19. - MDN-XXXX: blabla
  21. ## 0.1.0 - 2022-06-08
  22. ### Added:
  23.  - MDN-XXXX: blabla
  24.  - MDN-XXXX: blabla

Locally this code works great.
However, I want to use it in Jenkins, and there it's a security issues to directly import these:

  1. import java.nio.file.Files
  2. import java.nio.file.Paths
  3. import java.util.regex.Pattern

Hence, I need to change it to Jenkins friendly code.

So I changed it to this:

  1.     def changelogText = readFile(file: changelogFileName)
  3.     def pattern = "(?s)^## ${currentTag}.*?(?=\n\n## |\\z)"
  4.     def matcher = (changelogText =~ pattern)
  6.     if (matcher.find()) {
  7.         def latestChangelog = matcher.group();
  8.         println(latestChangelog.strip());
  9.     } else {
  10.         println('Could not parse latest changelog.');
  11.     }

However, I keep getting 'Could not parse latest changelog.'

It's quite hard to debug when I have to run it on Jenkins the whole time.
Does anyone know how to make the Jenkins libraries available locally, or better, how I can match using Pattern.MULTILINE?

Or perhaps a suggestion for a whole different approach?

答案1

得分: 1

以下是您要翻译的内容：

如果有人想要使用 awk，这是一个 awk 解决方案，但我仍然更喜欢上面的解决方案，因为如果最后一个条目 0.1.0 中有空行的话，它更好。

  1. #!/usr/bin/env groovy
  3. /**
  4.  * 从给定的文件名和标签获取最新的更改日志数据
  5.  * @param currentTag 字符串
  6.  * @param changelogFileName 字符串
  7.  */
  8. def call(
  9.     String currentTag = '0.1.0',
  10.     String changelogFileName = 'CHANGELOG.md'
  11. ) {
  12.     def changelogText  = sh(returnStdout: true, script: "awk '{ RS=\"\" } /## ${currentTag}.*?(^## |$)/' ${changelogFileName}").strip();
  13.     if (changelogText) {
  14.         return changelogText;
  15.     } else {
  16.         return "无法解析 ${changelogFileName} 中标签 ${currentTag} 的更改日志。更改日志已推送吗？或者更改日志可能包含语法错误？";
  17.     }
  18. }

希望这有所帮助！如果您需要进一步的翻译，请告诉我。

英文:

In case someone wants to use awk instead, this in an awk solution, however, I still prefer the above one as it's better in case if the last entry 0.1.0 has some empty lines in it.

  1. #!/usr/bin/env groovy
  3. /**
  4.  * Get latest changelog data from given filename and tag
  5.  * @param currentTag string
  6.  * @param changelogFileName string
  7.  */
  8. def call(
  9.     String currentTag = '0.1.0',
  10.     String changelogFileName = 'CHANGELOG.md'
  11. ) {
  12.     def changelogText  = sh(returnStdout: true, script: "awk '{ RS=\"\" } /## ${currentTag}.*?(^## |$)/' ${changelogFileName}").strip();
  13.     if (changelogText) {
  14.         return changelogText;
  15.     } else {
  16.         return "Could not parse the changelog of tag ${currentTag} in ${changelogFileName}. Is changelog pushed? Or perhaps the changelog contains a syntax error?";
  17.     }
  18. }

答案2

得分: 1

要匹配包括换行符在内的所有符号，您可以使用 [\s\S]。这将在没有任何标志的情况下工作。

考虑以下示例：

  1. String changelogText = """
  2. # Changelog - Project
  3. All notable changes to this project will be documented in this file.
  4. This project adheres to [Semantic Versioning](http://semver.org/).
  5. Changelog based on guidelines from
  6. [Keep a CHANGELOG](http://keepachangelog.com/).
  8. ## 0.3.0 - 2022-06-30
  9. ### Changed:
  10. - MDN-XXXX: blabla
  11. ### Also Changed:
  12. - MDN-XXXX: blabla
  14. ## 0.2.0 - 2022-06-09
  15. ### Added:
  16. - MDN-XXXX: blabla
  18. ## 0.1.1 - 2022-06-08
  19. ### Fixed:
  20. - MDN-XXXX: blabla
  22. ## 0.1.0 - 2022-06-08
  23. ### Added:
  24.  - MDN-XXXX: blabla
  25.  - MDN-XXXX: blabla
  26. """
  28. def currentTag = "0.2.0 - 2022-06-09"
  29. def pattern = /## ${currentTag}[\s\S]*?(?=\n\n## |\z)/
  30. def matcher = (changelogText =~ pattern)
  32. if (matcher.find()) {
  33.     def latestChangelog = matcher[0];
  34.     println(latestChangelog);
  35. } else {
  36.     println('Could not parse latest changelog.');
  37. }

输出：

  1. ## 0.2.0 - 2022-06-09
  2. ### Added:
  3. - MDN-XXXX: blabla
英文:

To match all symbols including newlines, you can use [\s\S]. This will work without any flags.

Consider the following demo:

  1. String changelogText = """
  2. # Changelog - Project
  3. All notable changes to this project will be documented in this file.
  4. This project adheres to [Semantic Versioning](http://semver.org/).
  5. Changelog based on guidelines from
  6. [Keep a CHANGELOG](http://keepachangelog.com/).
  8. ## 0.3.0 - 2022-06-30
  9. ### Changed:
  10. - MDN-XXXX: blabla
  11. ### Also Changed:
  12. - MDN-XXXX: blabla
  14. ## 0.2.0 - 2022-06-09
  15. ### Added:
  16. - MDN-XXXX: blabla
  18. ## 0.1.1 - 2022-06-08
  19. ### Fixed:
  20. - MDN-XXXX: blabla
  22. ## 0.1.0 - 2022-06-08
  23. ### Added:
  24.  - MDN-XXXX: blabla
  25.  - MDN-XXXX: blabla
  26. """
  28. def currentTag = "0.2.0 - 2022-06-09"
  29. def pattern = /## ${currentTag}[\s\S]*?(?=\n\n## |\z)/
  30. def matcher = (changelogText =~ pattern)
  32. if (matcher.find()) {
  33.     def latestChangelog = matcher[0];
  34.     println(latestChangelog);
  35. } else {
  36.     println('Could not parse latest changelog.');
  37. }

Output:

  1. ## 0.2.0 - 2022-06-09
  2. ### Added:
  3. - MDN-XXXX: blabla

huangapple
  • 本文由 发表于 2023年7月5日 00:51:42
  • 转载请务必保留本文链接：https://go.coder-hub.com/76614593.html
  • changelog
  • jenkins-groovy
  • multiline
  • regex
匿名

发表评论

匿名网友

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen:

确定