Adding ability to manage tag protections via settings

lib/plugins/tags.js

@@ -0,0 +1,34 @@
+const Diffable = require('./diffable')
+
+module.exports = class Tags extends Diffable {
+  async find () {
+    return this.github.repos.listTagProtection(this.repo).then(res => res.data)
+  }
+
+  comparator (existing, attrs) {
+    return existing.pattern === attrs.pattern
+  }
+
+  changed (existing, attrs) {
+    return existing.pattern !== attrs.pattern
+  }
+
+  async update (existing, attrs) {
+    const { owner, repo } = this.repo
+
+    this.github.issues.deleteTagProtection(Object.assign({ tag_protection_id: existing.id }, attrs, { owner, repo }))
+    return this.github.repos.createTagProtection(Object.assign({ pattern: attrs.pattern }, attrs, { owner, repo }))
+  }
+
+  add (attrs) {
+    const { owner, repo } = this.repo
+    return this.github.repos.createTagProtection(Object.assign({ pattern: attrs.pattern }, attrs, { owner, repo }))
+  }
+
+  remove (existing) {
+    const { owner, repo } = this.repo
+    return this.github.repos.deleteTagProtection(
+      Object.assign({ tag_protection_id: existing.id }, existing, { owner, repo })
+    )
+  }
+}

lib/settings.js

@@ -41,7 +41,8 @@ Settings.PLUGINS = {
   environments: require('./plugins/environments'),
   teams: require('./plugins/teams'),
   milestones: require('./plugins/milestones'),
-  branches: require('./plugins/branches')
+  branches: require('./plugins/branches'),
+  tags: require('./plugins/tags')
 }
 
 module.exports = Settings

test/fixtures/tags-config.yml

@@ -0,0 +1,3 @@
+tag_protection:
+  - pattern: "v1"
+  - pattern: "duplicate"

test/integration/plugins/tags.test.js

@@ -0,0 +1,39 @@
+const {
+  initializeNock,
+  loadInstance,
+  teardownNock,
+  repository,
+  buildTriggerEvent,
+  defineSettingsFileForScenario
+} = require('../common')
+const { OK, CREATED, NO_CONTENT } = require('http-status-codes')
+describe('tags plugin', function () {
+  let probot, githubScope
+
+  beforeEach(async () => {
+    githubScope = initializeNock()
+    probot = await loadInstance()
+  })
+
+  afterEach(() => {
+    teardownNock(githubScope)
+  })
+
+  it('configures tags', async () => {
+    await defineSettingsFileForScenario('tags-config.yml', githubScope)
+    githubScope.get(`/repos/${repository.owner.name}/${repository.name}/tags/protection`).reply(OK, [
+      { id: '1', pattern: '*' },
+      { id: '2', pattern: 'duplicate' }
+    ])
+
+    githubScope
+      .post(`/repos/${repository.owner.name}/${repository.name}/tags/protection`, body => {
+        expect(body).toMatchObject({ pattern: 'v1' })
+        return true
+      })
+      .reply(CREATED)
+    githubScope.delete(`/repos/${repository.owner.name}/${repository.name}/tags/protection/1`).reply(NO_CONTENT)
+
+    await probot.receive(buildTriggerEvent())
+  })
+})