ikikko · Feb 2, 2014 · Feb 3, 2014 · May 5, 2014 · May 5, 2014 · May 5, 2014
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: maven
+    directory: /
+    schedule:
+      interval: weekly
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml
@@ -0,0 +1 @@
+_extends: .github
diff --git a/.github/workflows/cd.yaml b/.github/workflows/cd.yaml
@@ -0,0 +1,59 @@
+# Note: additional setup is required, see https://www.jenkins.io/redirect/continuous-delivery-of-plugins
+
+name: cd
+on:
+  workflow_dispatch:
+  check_run:
+    types:
+      - completed
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    outputs:
+      should_release: ${{ steps.verify-ci-status.outputs.result == 'success' && steps.interesting-categories.outputs.interesting == 'true' }}
+    steps:
+      - name: Verify CI status
+        uses: jenkins-infra/verify-ci-status-action@v1.2.0
+        id: verify-ci-status
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          output_result: true
+
+      - name: Release Drafter
+        uses: release-drafter/release-drafter@v5
+        if: steps.verify-ci-status.outputs.result == 'success'
+        with:
+          name: next
+          tag: next
+          version: next
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Check interesting categories
+        uses: jenkins-infra/interesting-category-action@v1.1.0
+        id: interesting-categories
+        if: steps.verify-ci-status.outputs.result == 'success'
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  release:
+    runs-on: ubuntu-latest
+    needs: [validate]
+    if: needs.validate.outputs.should_release == 'true'
+    steps:
+      - name: Check out
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Set up JDK 8
+        uses: actions/setup-java@v3
+        with:
+          distribution: temurin
+          java-version: 8
+      - name: Release
+        uses: jenkins-infra/jenkins-maven-cd-action@v1.3.0
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }}
+          MAVEN_TOKEN: ${{ secrets.MAVEN_TOKEN }}
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '32 21 * * 1'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'java' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
diff --git a/.gitignore b/.gitignore
@@ -7,3 +7,6 @@ work/
 .settings/
 classes/
 src/test/resources/config.properties
+target
+.idea
+*.iml
diff --git a/.mvn/extensions.xml b/.mvn/extensions.xml
@@ -0,0 +1,7 @@
+<extensions xmlns="http://maven.apache.org/EXTENSIONS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/EXTENSIONS/1.0.0 http://maven.apache.org/xsd/core-extensions-1.0.0.xsd">
+  <extension>
+    <groupId>io.jenkins.tools.incrementals</groupId>
+    <artifactId>git-changelist-maven-extension</artifactId>
+    <version>1.3</version>
+  </extension>
+</extensions>
diff --git a/.mvn/maven.config b/.mvn/maven.config
@@ -0,0 +1,3 @@
+-Pconsume-incrementals
+-Pmight-produce-incrementals
+-Dchangelist.format=%d.v%s
diff --git a/.mvn/wrapper/maven-wrapper.jar b/.mvn/wrapper/maven-wrapper.jar
diff --git a/.mvn/wrapper/maven-wrapper.properties b/.mvn/wrapper/maven-wrapper.properties
@@ -0,0 +1,18 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+# 
+#   http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.4/apache-maven-3.8.4-bin.zip
+wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,23 @@
+# CHANGELOG
+
+## Version 1.3.0 (Dec 29, 2017)
+
+- Fix POST to /typetalk/notify with CSRF protection
+
+## Version 1.2.0 (Mar 14, 2017)
+
+- Support pipeline
+
+## Version 1.1.0 (Feb 25, 2015)
+
+- Add "operation from Typetalk" features
+
+## Version 1.0.0 (May 12, 2014)
+
+- v1 release
+- 'Notify When Success' in Post-build Actions section is removed.
+- If you use it, please 'Notify end' in Build Environment section instead of it.
+
+## Version 0.9.1 (Feb 3, 2014)
+
+- Initial release ( not finished i18n )
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,31 @@
+# Contributing to the Typetalk Plugin
+
+Plugin source code is hosted on [GitHub](https://github.com/jenkinsci/typetalk-plugin).
+New feature proposals and bug fix proposals should be submitted as
+[GitHub pull requests](https://help.github.com/articles/creating-a-pull-request).
+Your pull request will be evaluated by the [Jenkins job](https://ci.jenkins.io/job/Plugins/job/typetalk-plugin/).
+
+Before submitting your change, please assure that you've added tests that verify the change.
+
+## Code Coverage
+
+Code coverage reporting is available as a maven target.
+Please try to improve code coverage with tests when you submit.
+
+* `mvn -P enable-jacoco clean install jacoco:report` to report code coverage
+
+## Static Analysis
+
+Please don't introduce new spotbugs output.
+
+* `mvn spotbugs:check` to analyze project using [Spotbugs](https://spotbugs.github.io)
+* `mvn spotbugs:gui` to review report using GUI
+
+## File format
+
+Files in the repository are in Unix format (LF line terminators).
+Please continue using Unix file format for consistency.
+
+## Reporting Issues
+
+Report issues in the [Jenkins issue tracker](https://www.jenkins.io/participate/report-issue/redirect/#18421).
diff --git a/Jenkinsfile b/Jenkinsfile
@@ -0,0 +1,6 @@
+buildPlugin(
+  useContainerAgent: true,
+  configurations: [
+    [platform: 'linux', jdk: 8],
+    [platform: 'windows', jdk: 8],
+])
diff --git a/README.md b/README.md
@@ -1,25 +1,114 @@
-This is a Jenkins plugin which notifies to Typetalk ( https://typetalk.in/ )
+# Typetalk Plugin
 
-# How to build
-- ref : https://wiki.jenkins-ci.org/display/JENKINS/Gradle+JPI+Plugin
+## Introduction
 
-## Import to IDE
+This is a Jenkins plugin which works with [Typetalk](https://typetalk.com/). Typetalk is a chat tool provided by [Nulab](https://nulab.com).
 
-```
-gradle cleanEclipse eclipse
-gradle cleanIdea idea
-```
+## Feature
+
+### Send notification to Typetalk
+
+You can send notification to Typetalk when the following build events occur
+
+- when build starts / ends
+- when build fails
+
+![](docs/images/post_typetalk.png)
+
+### Operate Jenkins from Typetalk
+
+You can operate Jenkins by mentioning to a bot in Typetalk and this enables you to do ChatOps. If you can understand Japanese, Refer to [this blog entry](https://www.typetalk.com/ja/blog/chatops-without-programming/) for more details.
+
+This plugin provides some features, like build/list projects.
+
+#### Build project
+
+![](docs/images/chatops-build_en.gif)
+
+#### List projects
+
+![](docs/images/chatops-list_en.gif)
+
+#### Show help messages
+
+![](docs/images/chatops-help_en.gif)
+
+## Configuration
+
+### Global configuration
+
+At first, you must add credential to access Typetalk in the global configuration page.
+
+How to configure credentials:
+
+1. [Register a new application](https://typetalk.in/my/develop/applications/register) via the Typetalk Developer Application Page. Choose 'Client Credentials' in 'Grant Type'. Other items are optional.
+2. Input the 'Client ID' and 'Client Secret' displayed on the registration page. Input any value in 'Name'.
+
+![](docs/images/global_configuration.png)
 
-## Launch for development
+### Job configuration
+
+#### Build Environment
+
+In this section, you can configure notifications about starting/ending build.
+You can also change notification message as you like.
+
+![](docs/images/build_environment.png)
+
+#### Post-build Actions
+
+In this section, you can configure notifications about build results.
+The notifications are sent when the build doesn't succeed and recovers.
+
+![](docs/images/post_build_actions.png)
+
+#### Pipeline step
+
+You can use typetalk step in your pipeline as well as a classic style job.
+When you want to notify a build result, you can use 'typetalkSend' step with 'catchError'.
 
 ```
-gradle clean server
+node {
+    catchError {
+        sh 'might fail'
+    }
+    typetalkSend name: 'ikikko test', topicId: 9260
+}
 ```
 
-## Package a plugin file
+You can also notify an event which starts and/or ends with 'withTypetalk' step.
 
 ```
-gradle clean jpi
+withTypetalk(name: 'ikikko test', notifyEnd: true, notifyEndMessage: '', notifyStart: true, notifyStartMessage: '', topicId: 9260) {
+    // some block
+}
 ```
 
-If you don't install gradle, you can use gradlew / gradlew.bat instead of gradle.
+#### Notification URL
+
+In order to operate Jenkins from Typetalk, you should set a certain endpoint to Typetalk bot in a topic.
+
+### Bot for all Jenkins projects
+
+This plugin provides the following endpoint to receive message from Typetalk. You have to set it to a webhook URL of Typetalk bot. See the official document for more.
+
+`http://<Jenkins URL>/typetalk/notify`
+
+Then, you can operate Jenkins by mentioning to the bot as follows:
+
+- `@jenkins+ build <project> (<key=value>)`
+- `@jenkins+ list (<regexp filter>)`
+- `@jenkins+ help (<sub command>)`
+
+In this case, @jenkins+ is your bot name here.
+
+### Bot for a single Jenkins project
+
+By adding project name as a parameter of webhook URL,
+
+`http://<Jenkins URL>/typetalk/notify?project=<project>`
+
+then you can omit the name when mentioning to Typetalk bot like this.
+
+- `@jenkins-project+`
+- `@jenkins-project+ build (<key=value>)`