Merge pull request #479 from buildkite-plugins/SUP-1263_TagVersioning…

…_Update Sup 1263 - Tag versioning update
buildkite-plugins · Jul 19, 2023 · 948d40e · 948d40e
2 parents 65f6176 + 6540d9f
commit 948d40e
Show file tree

Hide file tree

Showing 10 changed files with 36 additions and 3 deletions.
diff --git a/lib/linters/example-linter.js b/lib/linters/example-linter.js
@@ -107,7 +107,7 @@ module.exports = async function (argv, tap) {
       refMatches = pluginRef.pathname === `/${id}`
     }
 
-    return refMatches && hash && hash.startsWith('#v')
+    return refMatches && hash && hash.startsWith('#')
   }
 
   function extractPluginConfigs (exampleYaml) {

diff --git a/lib/linters/readme-version-number-linter.js b/lib/linters/readme-version-number-linter.js
@@ -6,7 +6,7 @@ const { compareVersions, validate } = require('compare-versions')
 module.exports = async function (argv, tap) {
   const { id, path: pluginPath, readme, silent } = argv
 
-  const pluginConfigKeyPattern = new RegExp(`${id}#(v.*):`, 'g')
+  const pluginConfigKeyPattern = new RegExp(`${id}#(v?.*):`, 'g')
 
   const readmePath = path.join(pluginPath, readme)
   const readmeContents = fs.readFileSync(readmePath, 'utf8')

diff --git a/test/example-linter.test.js b/test/example-linter.test.js
@@ -16,6 +16,14 @@ describe('example-linter', () => {
         readme: 'README.md'
       }, tap))
     })
+    it('should be valid without v', async () => {
+      assert(await linter({
+        id: 'valid-plugin',
+        path: path.join(fixtures, 'valid-plugin'),
+        silent: true,
+        readme: 'README-with-anything.md'
+      }, tap))
+    })
   })
   describe('valid plugin with yaml instead of yml', () => {
     it('should be valid', async () => {

diff --git a/test/example-linter/valid-plugin/README-with-anything.md b/test/example-linter/valid-plugin/README-with-anything.md
@@ -0,0 +1,8 @@
+# Example
+
+```yml
+steps:
+  - plugins:
+      - valid-plugin#p1.2.3:
+          option: value
+```
diff --git a/test/readme-version-number-linter.test.js b/test/readme-version-number-linter.test.js
@@ -57,6 +57,16 @@ describe('readme-version-number-linter', () => {
       }, tap))
     })
   })
+  describe('readme with out of date version numbers and no v prefix', () => {
+    it('should be invalid', async () => {
+      assert.isFalse(await linter({
+        id: 'out-of-date',
+        path: initGitFixture(path.join(fixtures, 'out-of-date')),
+        readme: 'README-No-Version.md',
+        silent: true
+      }, tap))
+    })
+  })
   describe('readme withan invalid version number', () => {
     it('should ignore the invalid', async () => {
       assert(await linter({

diff --git a/test/readme-version-number-linter/custom-readme/custom-readme.md b/test/readme-version-number-linter/custom-readme/custom-readme.md
@@ -1,3 +1,4 @@
 steps:
   - plugins:
       - custom-readme#v1.0.0: ~
+      - custom-readme#1.0.0: ~
diff --git a/test/readme-version-number-linter/future-version/README.md b/test/readme-version-number-linter/future-version/README.md
@@ -1,3 +1,4 @@
 steps:
   - plugins:
       - future-version#v2.0.0: ~
+      - future-version#2.0.0: ~
diff --git a/test/readme-version-number-linter/invalid-sem-ver-tags/README.md b/test/readme-version-number-linter/invalid-sem-ver-tags/README.md
@@ -1,3 +1,4 @@
 steps:
   - plugins:
-      - invalid-sem-ver-tags#v0.2.0: ~  
+      - invalid-sem-ver-tags#v0.2.0: ~
+      - invalid-sem-ver-tags#0.2.0: ~
diff --git a/test/readme-version-number-linter/out-of-date/README-No-Version.md b/test/readme-version-number-linter/out-of-date/README-No-Version.md
@@ -0,0 +1,3 @@
+steps:
+  - plugins:
+      - out-of-date#0.0.1: ~
diff --git a/test/readme-version-number-linter/up-to-date/README.md b/test/readme-version-number-linter/up-to-date/README.md
@@ -1,3 +1,4 @@
 steps:
   - plugins:
       - up-to-date#v1.0.0: ~
+      - up-to-date#1.0.0: ~