6 | <%- include('navigation'); %>
7 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
--------------------------------------------------------------------------------
/views/progress.ejs:
--------------------------------------------------------------------------------
1 |
2 |
3 | <%- include('header', {title: "Plugin Migration Progress"}); %>
4 |
5 |
8 |
36 |
9 |
16 |
17 | 18 |
19 | 17 | 18 |
20 | Format
21 |
22 | 23 | 24 | 25 | 26 |
27 | 22 | 23 | 24 | 25 | 26 |
28 |
29 |
30 |
31 |
32 |
33 | 34 |
35 | 33 | 34 |
6 | <%- include('navigation'); %>
7 |
11 |
12 |
39 | <% if (recent.length) { %>
40 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
53 |
--------------------------------------------------------------------------------
/views/navigation.ejs:
--------------------------------------------------------------------------------
1 |
44 |
--------------------------------------------------------------------------------
/public/index.js:
--------------------------------------------------------------------------------
1 | /* eslint-env browser */
2 | const $markdown = document.getElementById('markdown');
3 | const $pluginName = document.getElementById('pluginName');
4 | const $convertButton = document.getElementById('convertButton');
5 |
6 | const onsubmit = function(ev) {
7 | ev.preventDefault();
8 | const type = document.querySelector('#format:checked').value;
9 | const pluginName = $pluginName.value;
10 | fetchContent(pluginName, type);
11 | };
12 |
13 | const onPageLoad = function() {
14 | const params = parseUrl();
15 | const pluginName = params.pluginName;
16 | if (pluginName) {
17 | $pluginName.value = pluginName;
18 | fetchContent(pluginName, params.type || '.md');
19 | }
20 | };
21 |
22 | const fetchContent = function(pluginName, type) {
23 | $markdown.value = 'Pending....';
24 | let url = './plugin/' + encodeURIComponent(pluginName) + type;
25 | if (pluginName.match(/^https?\:\/\//)) {
26 | url = '/confluence-url/' + encodeURIComponent(pluginName) + type;
27 | }
28 |
29 | fetch(url, {responseType: 'blob'})
30 | .then(function(response) {
31 | if (!response.ok) {
32 | return response.text().then((text) => {
33 | throw Error(text || response.statusText);
34 | });
35 | }
36 | return response;
37 | })
38 | .then((response) => {
39 | if (response.headers.get('content-type').includes('/zip')) {
40 | return response.blob()
41 | .then((blob) => {
42 | $markdown.value = 'Saving...';
43 | window.saveAs(blob, pluginName + type);
44 | });
45 | } else {
46 | return response.text().then((body) => $markdown.value = body);
47 | }
48 | })
49 | .catch((err) => $markdown.value = 'Error: ' + err.toString());
50 | };
51 |
52 | const parseUrl = function() {
53 | const query = location.search.replace(/^\?/, '').split('&');
54 | const params = {};
55 | query.forEach(function(tuple) {
56 | const keyAndVal = tuple.split('=');
57 | params[keyAndVal[0]] = keyAndVal[1];
58 | });
59 | return params;
60 | };
61 |
62 | window.addEventListener('load', onPageLoad);
63 | $pluginName.addEventListener('keydown', function(e) {
64 | if (e.key == 'Enter') {
65 | e.preventDefault();
66 | onsubmit(e);
67 | return;
68 | }
69 | });
70 | $convertButton.addEventListener('click', onsubmit);
71 | $markdown.value = '';
72 |
--------------------------------------------------------------------------------
/reports.test.js:
--------------------------------------------------------------------------------
1 | /* eslint-env node, jest */
2 | const MockDate = require('mockdate');
3 | const crypto = require('crypto');
4 | const path = require('path');
5 |
6 | const talkback = require('talkback');
7 |
8 | const {pluginsReport} = require('./reports.js');
9 |
10 | jest.setTimeout(30000); // 30 seconds
11 |
12 | let server;
13 | beforeEach(function() {
14 | MockDate.set(new Date('2020-05-25 00:00:00Z'));
15 | });
16 |
17 | beforeAll(async function() {
18 | const port = 8888;
19 | process.env.GITHUB_SERVER = `http://localhost:${port}/graphql`;
20 | server = await talkback({
21 | host: 'https://api.github.com',
22 | port: port,
23 | path: path.join(__dirname, '__testData', 'vcr'),
24 | silent: true,
25 | ignoreHeaders: ['authorization'],
26 | ignoreQueryParams: ['adminuser', 'admintoken'],
27 | tapeNameGenerator: (tapeNumber, tape) => {
28 | const content = tape.req.body.toString();
29 | const hash = crypto.createHash('md5').update(content).digest('hex');
30 | const matches = content.match(/query (\w+)/);
31 | if (matches && matches[1]) {
32 | const variables = Object.entries(
33 | JSON.parse(content).variables,
34 | ).map(
35 | ([key, value]) => `${key}_${value}`,
36 | ).join('_');
37 | return `${tape.req.method.toLowerCase()}_${matches[1]}_${variables}_${hash}.json5`;
38 | }
39 |
40 | return `${tape.req.method.toLowerCase()}_${hash}.json5`;
41 | },
42 | }).start();
43 | });
44 | afterAll(function(done) {
45 | server.close(done);
46 | });
47 |
48 |
49 | describe('reports', function() {
50 | describe('happy path', function() {
51 | beforeAll( async () => {
52 | this.reportData = await pluginsReport();
53 | });
54 | it('should mark multiple-scms as deprecated', () => {
55 | expect(this.reportData.plugins.find(
56 | (plugin) => plugin.name == 'multiple-scms',
57 | )['labels']).toEqual([
58 | 'deprecated', 'scm',
59 | ]);
60 | });
61 | it('have all the statuses ', () => {
62 | expect(this.reportData.statuses).toHaveProperty('ok');
63 | expect(this.reportData.statuses).toHaveProperty('pr merged');
64 | expect(this.reportData.statuses).toHaveProperty('pr open');
65 | expect(this.reportData.statuses).toHaveProperty('deprecated');
66 | expect(this.reportData.statuses).toHaveProperty('todo');
67 | expect(this.reportData.statuses).toHaveProperty('total');
68 | });
69 | });
70 | });
71 |
--------------------------------------------------------------------------------
/confluence.js:
--------------------------------------------------------------------------------
1 | /* eslint-env node */
2 | const {basename} = require('path');
3 | const URL = require('url');
4 | const bunyan = require('bunyan');
5 | const axios = require('./axios');
6 | const Confluence = require('confluence-api');
7 | const DomParser = require('dom-parser');
8 | const cheerio = require('cheerio');
9 | const {promisify} = require('util');
10 |
11 | const logger = bunyan.createLogger({
12 | name: basename(process.argv[0]) + ':confluence',
13 | });
14 |
15 | const confluence = new Confluence({
16 | username: process.env.CONFLUENCE_USERNAME,
17 | password: process.env.CONFLUENCE_PASSWORD,
18 | baseUrl: 'https://wiki.jenkins.io',
19 | version: 4,
20 | });
21 | confluence.getContentByIdPromise = promisify(confluence.getContentById);
22 |
23 |
24 | /**
25 | * Get the content part of Confluence page, without URL processing
26 | * @param {string} url confluence url
27 | * @return {string} content
28 | */
29 | async function getRawConfluenceContent(url) {
30 | logger.info('getRawConfluenceContent: looking up ' + url);
31 | const body = await axios.get(url).then((response) => response.data);
32 | const domParser = new DomParser();
33 | const dom = domParser.parseFromString(body);
34 | const meta = dom.getElementsByTagName('meta').find((elm)=>elm.getAttribute('name') === 'ajs-page-id');
35 | if (!meta) {
36 | throw new Error('No meta page id found');
37 | }
38 | const pageId = meta.getAttribute('content');
39 | if (!pageId) {
40 | throw new Error('No page id found');
41 | }
42 | return cheerio.load(body)('.wiki-content').html();
43 | }
44 |
45 | /**
46 | * Get's content from a confluence page
47 | * Remove's some content that we don't want
48 | *
49 | * @param {*} url confluence url
50 | * @param {*} fragment relevant part of page content
51 | * @return {string} processed html
52 | */
53 | function getContentFromConfluencePage(url, fragment) {
54 | const $ = cheerio.load(fragment);
55 | $('.conf-macro.output-inline th:contains("Plugin Information")').parents('table').remove();
56 |
57 | // Remove any table of contents
58 | $('.toc').remove();
59 |
60 | // Replace href/src with the wiki url
61 | $('[href]').each((idx, elm) => {
62 | $(elm).attr('href', URL.resolve(url, $(elm).attr('href')));
63 | });
64 | $('[src]').each((idx, elm) => {
65 | $(elm).attr('src', URL.resolve(url, $(elm).attr('data-image-src') || $(elm).attr('src')));
66 | });
67 | return $.html();
68 | }
69 |
70 | module.exports = {
71 | getRawConfluenceContent,
72 | getContentFromConfluencePage,
73 | };
74 |
--------------------------------------------------------------------------------
/.github/settings.yml:
--------------------------------------------------------------------------------
1 | repository:
2 | name: jenkins-wiki-exporter
3 | description: Quick util to convert jenkins plugin wiki format to github markdown or asciidoc
4 | homepage: https://jenkins-wiki-exporter.jenkins.io
5 | topics: 'confluence, jenkins, hacktoberfest, pandoc'
6 | private: false
7 | default_branch: master
8 | has_issues: true
9 | has_wiki: false
10 | allow_merge_commit: true
11 | allow_squash_merge: true
12 | allow_rebase_merge: true
13 |
14 | #TODO(oleg-nenashev): Consider moving to https://github.com/jenkinsci/.github once https://github.com/probot/settings/issues/107 is fixed
15 | labels:
16 | - name: good first issue
17 | color: 7057ff
18 | - name: hackathon
19 | color: 85f920
20 | - name: help wanted
21 | color: 008672
22 | - name: question
23 | color: D876E3
24 | - name: wontfix
25 | color: FFFFFF
26 | - name: duplicate
27 | color: CFD3D7
28 | - name: bug
29 | color: D73A4A
30 | - name: documentation
31 | color: 0e8a16
32 | description: A PR that adds to documentation - used by Release Drafter
33 | - name: hacktoberfest
34 | color: bdff3a
35 | description: 'Hacktoberfest. https://jenkins.io/blog/2018/10/01/hacktoberfest/'
36 | - name: feature
37 | color: 1d00ff
38 | description: A PR that adds a feature - used by Release Drafter
39 | - name: bugfix
40 | oldname: fix
41 | color: c9e85c
42 | description: A PR that fixes a bug - used by Release Drafter
43 | - name: chore
44 | color: c9abea
45 | description: a PR that adds to maintenance - used by Release Drafter
46 | - name: test
47 | color: d6e819
48 | description: A PR that adds to testing - used by Release Drafter
49 | - name: pinned
50 | color: 5ed5e5
51 | description: 'Used to avoid stale[bot] marking a issue/PR stale'
52 | - name: plugin-compatibility
53 | color: 8425c4
54 | - name: stale
55 | color: ffffff
56 | description: 'Used by stale[bot] to mark a issue/PR stale'
57 | - name: skip-changelog
58 | color: f44271
59 | description: A PR that is excluded from Release draft - used by Release Drafter
60 | - name: removed
61 | color: aa0f1c
62 | description: A PR that removes code - used by Release Drafter
63 | - name: deprecated
64 | color: e2b626
65 | description: A PR that deprecates code - used by Release Drafter
66 | - name: breaking
67 | color: 640910
68 | description: A PR that is a breaking change - used by Release Drafter
69 | - name: dependencies
70 | color: 0366d6
71 | description: A PR that updates dependencies - used by Release Drafter
72 |
--------------------------------------------------------------------------------
/utils.test.js:
--------------------------------------------------------------------------------
1 | /* eslint-env node, jest */
2 | const {
3 | findImages,
4 | checkUrl,
5 | replaceConfluenceContent,
6 | getAllPluginNamesForRepo,
7 | } = require('./utils.js');
8 |
9 | const fs = require('fs');
10 | describe('utils', function() {
11 | it('findImages', async () => {
12 | const images = findImages(require('./__testData/cron_column.json').wiki.content);
13 | expect(images).toEqual([
14 | 'https://wiki.jenkins.io/download/attachments/43712750/Hudson%20Plugin%20-%20Cron%20Column.jpg?version=1&modificationDate=1271470566000&api=v2',
15 | 'https://wiki.jenkins.io/download/attachments/43712750/Hudson%20Plugin%20-%20Cron%20Column.jpg?version=1&modificationDate=1271470566000&api=v2',
16 | ]);
17 | });
18 | it('findImages with empty URL', async () => {
19 | const images = findImages(require('./__testData/github.json').wiki.content);
20 | expect(images).toEqual([
21 | 'https://wiki.jenkins.io/download/attachments/37749162/changes.png?version=1&modificationDate=1244761866000&api=v2',
22 | 'https://wiki.jenkins.io/download/thumbnails/37749162/changes.png?version=1&modificationDate=1244761866000&api=v2',
23 | 'https://wiki.jenkins.io/download/attachments/37749162/changes-2.png?version=1&modificationDate=1244761881000&api=v2',
24 | 'https://wiki.jenkins.io/download/thumbnails/37749162/changes-2.png?version=1&modificationDate=1244761881000&api=v2',
25 | 'https://wiki.jenkins.io/s/en_GB/8100/5084f018d64a97dc638ca9a178856f851ea353ff/_/images/icons/emoticons/help_16.svg',
26 | 'https://wiki.jenkins.io/download/attachments/37749162/ghserver-config.png?version=1&modificationDate=1441295981000&api=v2',
27 | 'https://wiki.jenkins.io/download/thumbnails/37749162/ghserver-config.png?version=1&modificationDate=1441295981000&api=v2',
28 | 'https://wiki.jenkins.io/download/attachments/37749162/manage-token.png?version=1&modificationDate=1441297409000&api=v2',
29 | 'https://wiki.jenkins.io/download/thumbnails/37749162/manage-token.png?version=1&modificationDate=1441297409000&api=v2',
30 | 'https://wiki.jenkins.io/download/attachments/37749162/secret-text.png?version=1&modificationDate=1441295988000&api=v2',
31 | 'https://wiki.jenkins.io/download/thumbnails/37749162/secret-text.png?version=1&modificationDate=1441295988000&api=v2',
32 | ]);
33 | });
34 | it('checkUrl', () => {
35 | expect(checkUrl(['wiki.jenkins.io'], 'https://wiki.jenkins.io/something')).toBe(true);
36 | });
37 | it('replaceConfluenceContent', () => {
38 | const input = fs.readFileSync('test-data/with-classes.html', 'utf8').trim();
39 | const expected = fs.readFileSync('test-data/with-classes-removed.html', 'utf8').trim();
40 | expect(replaceConfluenceContent(input)).toBe(expected);
41 | });
42 | describe.each([
43 | ['https://github.com/jenkinsci/cloudbees-disk-usage-simple-plugin/pull/28', 'cloudbees-disk-usage-simple'],
44 | ['https://github.com/jenkinsci/groovy', 'groovy'],
45 | ['https://github.com/jenkinsci/backend-pull-request-greeter', 'backend-pull-request-greeter'],
46 | ])('pluginNameFromUrl(%s)', (url, expected) => {
47 | test(`returns ${expected}`, () => {
48 | expect(getAllPluginNamesForRepo(url, {})[0]).toBe(expected);
49 | });
50 | });
51 | });
52 |
53 |
--------------------------------------------------------------------------------
/index.test.js:
--------------------------------------------------------------------------------
1 | /* eslint-env node, jest */
2 | process.env.CONFLUENCE_USERNAME = process.env.CONFLUENCE_PASSWORD = 'fake';
3 |
4 | const sut = require('./index.js');
5 | const MockExpressRequest = require('mock-express-request');
6 | const MockExpressResponse = require('mock-express-response');
7 | const mockWikiPrefix = 'https://wiki.jenkins.io/display/JENKINS/';
8 | jest.mock('./confluence.js', () => ({
9 | ...jest.requireActual('./confluence.js'),
10 | getRawConfluenceContent: (url) => {
11 | const pluginName = url.replace(mockWikiPrefix, '');
12 | return require('fs').promises.readFile(`__testData/${pluginName}.json`)
13 | .then((buf) => JSON.parse(buf.toString()).wiki.content);
14 | },
15 | }));
16 |
17 | jest.mock('./reports.js', () => ({
18 | ...jest.requireActual('./reports.js'),
19 | getPluginWikiUrl: (pluginName) => {
20 | return `${mockWikiPrefix}${pluginName}`;
21 | },
22 | }));
23 |
24 | const makeLogger = () => {
25 | return {
26 | debug: jest.fn(),
27 | error: jest.fn(),
28 | };
29 | };
30 |
31 | describe('/plugin/:pluginName', function() {
32 | it('handle the basics', async () => {
33 | const logger = makeLogger();
34 | const req = new MockExpressRequest({
35 | log: logger,
36 | params: {
37 | plugin: 'html5-notifier-plugin',
38 | },
39 | });
40 | const res = {
41 | send: jest.fn(),
42 | type: jest.fn(),
43 | };
44 |
45 | await sut.requestPluginHandler(req, res);
46 | expect(res.send.mock.calls).toMatchSnapshot();
47 | expect(logger.error.mock.calls).toEqual([]);
48 | });
49 |
50 | it('markdown should return markdown', async () => {
51 | const logger = makeLogger();
52 | const req = new MockExpressRequest({
53 | log: logger,
54 | params: {
55 | plugin: 'html5-notifier-plugin',
56 | format: 'md',
57 | },
58 | });
59 | const res = {
60 | send: jest.fn(),
61 | type: jest.fn(),
62 | };
63 |
64 | await sut.requestPluginHandler(req, res);
65 | expect(res.send.mock.calls).toMatchSnapshot();
66 | expect(logger.error.mock.calls).toEqual([]);
67 | });
68 | // / this one is actually talking to the wiki for some reason, so ignore it
69 | it.skip('markdown.zip should return markdown and images in zip', async () => {
70 | const logger = makeLogger();
71 | const req = new MockExpressRequest({
72 | log: logger,
73 | params: {
74 | plugin: 'html5-notifier-plugin',
75 | format: 'md.zip',
76 | },
77 | });
78 | const res = new MockExpressResponse({ });
79 |
80 | await sut.requestPluginHandler(req, res);
81 | expect(res._getString()).toMatchSnapshot();
82 | expect(logger.error.mock.calls).toEqual([]);
83 | });
84 | it('adoc should return asciidoc', async () => {
85 | const logger = makeLogger();
86 | const req = new MockExpressRequest({
87 | log: logger,
88 | params: {
89 | plugin: 'html5-notifier-plugin',
90 | format: 'adoc',
91 | },
92 | });
93 | const res = {
94 | send: jest.fn(),
95 | type: jest.fn(),
96 | };
97 |
98 | await sut.requestPluginHandler(req, res);
99 | expect(res.send.mock.calls).toMatchSnapshot();
100 | expect(logger.error.mock.calls).toEqual([]);
101 | });
102 | });
103 |
104 |
--------------------------------------------------------------------------------
/reports.js:
--------------------------------------------------------------------------------
1 | /* eslint-env node */
2 | const axios = require('./axios');
3 | const {getPullRequests} = require('./graphql.js');
4 | const {getCached, getAllPluginNamesForRepo} = require('./utils.js');
5 | const moment = require('moment');
6 |
7 | const docsUrl = 'http://updates.jenkins.io/plugin-documentation-urls.json';
8 |
9 | /**
10 | * Get the content of the progress report
11 | * @return {array} of objects representing table rows
12 | */
13 | async function pluginsReport() {
14 | const updateCenterUrl = 'https://updates.jenkins.io/current/update-center.actual.json';
15 |
16 |
17 | const documentation = await getContent(docsUrl, 'json');
18 | const uc = await getContent(updateCenterUrl, 'json');
19 | const pulls = await getCached('get-pulls', () => getPulls(uc.plugins));
20 | const report = [];
21 | const recent = [];
22 | Object.keys(uc.plugins).forEach(function(key) {
23 | const plugin = uc.plugins[key];
24 | const url = documentation[key].url || '';
25 | plugin.name = key;
26 | plugin.installs = plugin.popularity || 0;
27 | plugin.releaseDate = moment(plugin.releaseTimestamp).format('YYYY-MM-DD');
28 | if (url.match('https?://github.com/jenkinsci/')) {
29 | plugin.status = 'OK';
30 | plugin.className = 'success';
31 | if (pulls['merged'][key]) {
32 | recent.push(key);
33 | }
34 | } else if (plugin.labels.includes('deprecated') ||
35 | Object.keys(uc.deprecations).includes(plugin.name)) {
36 | plugin.status = 'deprecated';
37 | plugin.className = 'success';
38 | } else if (pulls['merged'][key]) {
39 | plugin.status = 'PR merged';
40 | plugin.className = 'info';
41 | plugin.action = pulls['merged'][key];
42 | } else if (pulls['open'][key]) {
43 | plugin.status = 'PR open';
44 | plugin.className = 'info';
45 | plugin.action = pulls['open'][key];
46 | } else {
47 | plugin.status = 'TODO';
48 | plugin.action = '/?pluginName=' + plugin.name;
49 | }
50 | report.push(plugin);
51 | });
52 | report.sort((a, b) => b.installs - a.installs);
53 |
54 | const statuses = report.reduce((statuses, report) => {
55 | statuses[report.status.toLowerCase()] = (statuses[report.status.toLowerCase()] || 0) + 1;
56 | return statuses;
57 | }, {});
58 | statuses.total = report.length;
59 | return {
60 | plugins: report,
61 | statuses,
62 | recent,
63 | };
64 | }
65 |
66 | /**
67 | * Gets documentation URL for a plugin from Update Center
68 | * @param {string} pluginId plugin ID
69 | * @return {string} documentation URL
70 | */
71 | async function getPluginWikiUrl(pluginId) {
72 | const documentation = await getContent(docsUrl, 'json');
73 | if (documentation[pluginId]) {
74 | return documentation[pluginId].url.replace('//wiki.jenkins-ci.org', '//wiki.jenkins.io');
75 | }
76 | return '';
77 | }
78 |
79 | /**
80 | * Gets list of all unreleased pull requests from GitHub project
81 | * @param {plugins} plugins map (plugin name) => plugin properties (see update-center.actual.json)
82 | * @return {object} nested map (state) => (plugin name) => url
83 | */
84 | async function getPulls(plugins) {
85 | const repoToPlugins = {};
86 | Object.keys(plugins).forEach(function(key) {
87 | const scm = plugins[key].scm;
88 | repoToPlugins[scm] = repoToPlugins[scm] || [];
89 | repoToPlugins[scm].push(key);
90 | });
91 | const data = await getPullRequests();
92 | const columns = data.organization.project.columns.edges;
93 | return {'open': await getPullMap(columns[1], repoToPlugins), 'merged': await getPullMap(columns[2], repoToPlugins)};
94 | }
95 |
96 | /**
97 | * Gets PRs for one column
98 | * @param {object} column from GraphQL
99 | * @param {object} repoToPlugins map (repo URL) => list of plugin IDs
100 | * @return {object} map (plugin name) => url
101 | */
102 | async function getPullMap(column, repoToPlugins) {
103 | const projectToPull = {};
104 | for (const edge of column.node.cards.edges) {
105 | if (!edge.node.content) {
106 | continue;
107 | }
108 | if (!edge.node.content.url) {
109 | continue;
110 | }
111 | const {url} = edge.node.content;
112 | const pluginNames = getAllPluginNamesForRepo(url, repoToPlugins);
113 | pluginNames.forEach(function(pluginName) {
114 | projectToPull[pluginName] = url;
115 | });
116 | }
117 | return projectToPull;
118 | }
119 |
120 | /**
121 | * Load content from URL, using cache.
122 | * @param {string} url
123 | * @param {string} type 'json' or 'blob'
124 | * @return {object} JSON object or string
125 | */
126 | async function getContent(url, type) {
127 | return getCached(
128 | url,
129 | () => axios.get(url, {'type': type}).then((response) => response.data),
130 | );
131 | }
132 |
133 | module.exports = {
134 | pluginsReport,
135 | getPluginWikiUrl,
136 | };
137 |
--------------------------------------------------------------------------------
/test-data/with-classes-removed.html:
--------------------------------------------------------------------------------
1 | Plugin Migration Progress
8 |Todo: <%= statuses.todo %>, PR open: <%= statuses["pr open"] %>, PR merged: <%= statuses["pr merged"] %>, Done: <%= statuses.ok + statuses.deprecated %>, Total: <%= statuses.total %>
9 | 10 || Plugin Name | 13 |Status | 14 |Last release | 15 |Installs | 16 | 17 | <% plugins.forEach(function(plugin) { %> 18 |
|---|---|---|---|
| 20 | 21 | <%= plugin.name %> 22 | 23 | | 24 |25 | 26 | <%= plugin.status %> 27 | 28 | | 29 | 30 |31 | <%= plugin.releaseDate %> 32 | | 33 |34 | <%= plugin.installs %> 35 | | 36 |
Recently merged
41 | <%= recent.join(", ") %> 42 | <% } %> 43 |Summary
2 |This Plugin will notify the ChatWork any message.
3 |
4 | Table of content
7 | 8 |
9 |
10 |
11 | Usage
12 |Global Configuration
13 |
Job Configuration
15 |
-
17 |
- Success message , Failure message , Unstable message , Not built message , Aborted message
18 |
-
19 |
- If message is empty, used Global message 20 |
- emoticon 21 |
- chatwork tags 22 |
23 |
-
25 |
- Default message is supported some variables. 26 |
example
28 |-
29 |
- build variables (ex. $JOB_NAME , $BUILD_URL ) 30 |
- environment variables (ex. $PATH , $JAVA_HOME ) 31 |
- $BUILD_RESULT (ex. SUCCESS, FAILED ) 32 |
Changelog
34 |Details https://github.com/jenkinsci/chatwork-plugin/blob/master/CHANGELOG.md
35 |Version 1.0.9 (Sep 14, 2019)
36 |-
37 |
- [Security] Save apiKey to Secret field instead of String field
38 |
-
39 |
- Plain apiKey is automatically encrypted and stored when Global Configuration saving 40 |
41 |
Version 1.0.8 (Jan 27, 2017)
43 |-
44 |
- Update API version (v2) 45 |
Version 1.0.6 (Dec 1, 2016)
47 |-
48 |
- Fix NullPointerException when contains canceled user 49 |
Version 1.0.5 (Mar 23, 2016)
51 |-
52 |
- Sanitize special char in room name 53 |
Version 1.0.4 (Nov 11, 2015)
55 |-
56 |
- Bugfix causing null value exception when received Github payload json (neither PullRequest nor compare) 57 |
Version 1.0.3 (Oct 8, 2015)
59 |-
60 |
- Bugfix multibyte garbled 61 |
Version 1.0.2 (Sep 25, 2015)
63 |-
64 |
- Remove legacy help 65 |
Version 1.0.1 (Sep 25, 2015)
67 |-
68 |
- Add room selection pulldown instead of textbox 69 |
Version 1.0.0 (Mar 8, 2015)
71 |-
72 |
- Add build result pattern messages 73 |
- Add global messages 74 |
NOTE
76 |Default message (below v0.6.2) is removed. If upgrade from v0.x to 1.0.0+, Default message is copied to Success message, Failure message, Unstable message, Not built message and Aborted message
77 |Version 0.6.2 (Jan 22, 2015)
78 |-
79 |
- Support variable to room id 80 |
Version 0.6.1 (Jan 14, 2015)
82 |-
83 |
- Bugfix: Failed to serialize 84 |
Summary
2 |This Plugin will notify the ChatWork any message.
3 |
4 | Table of content
7 | 8 |
9 |
10 |
11 | Usage
12 |Global Configuration
13 |
Job Configuration
15 |
-
17 |
- Success message , Failure message , Unstable message , Not built message , Aborted message
18 |
-
19 |
- If message is empty, used Global message 20 |
- emoticon 21 |
- chatwork tags 22 |
23 |
-
25 |
- Default message is supported some variables. 26 |
example
28 |-
29 |
- build variables (ex. $JOB_NAME , $BUILD_URL ) 30 |
- environment variables (ex. $PATH , $JAVA_HOME ) 31 |
- $BUILD_RESULT (ex. SUCCESS, FAILED ) 32 |
Changelog
34 |Details https://github.com/jenkinsci/chatwork-plugin/blob/master/CHANGELOG.md
35 |Version 1.0.9 (Sep 14, 2019)
36 |-
37 |
- [Security] Save apiKey to Secret field instead of String field
38 |
-
39 |
- Plain apiKey is automatically encrypted and stored when Global Configuration saving 40 |
41 |
Version 1.0.8 (Jan 27, 2017)
43 |-
44 |
- Update API version (v2) 45 |
Version 1.0.6 (Dec 1, 2016)
47 |-
48 |
- Fix NullPointerException when contains canceled user 49 |
Version 1.0.5 (Mar 23, 2016)
51 |-
52 |
- Sanitize special char in room name 53 |
Version 1.0.4 (Nov 11, 2015)
55 |-
56 |
- Bugfix causing null value exception when received Github payload json (neither PullRequest nor compare) 57 |
Version 1.0.3 (Oct 8, 2015)
59 |-
60 |
- Bugfix multibyte garbled 61 |
Version 1.0.2 (Sep 25, 2015)
63 |-
64 |
- Remove legacy help 65 |
Version 1.0.1 (Sep 25, 2015)
67 |-
68 |
- Add room selection pulldown instead of textbox 69 |
Version 1.0.0 (Mar 8, 2015)
71 |-
72 |
- Add build result pattern messages 73 |
- Add global messages 74 |
NOTE
76 |Default message (below v0.6.2) is removed. If upgrade from v0.x to 1.0.0+, Default message is copied to Success message, Failure message, Unstable message, Not built message and Aborted message
77 |Version 0.6.2 (Jan 22, 2015)
78 |-
79 |
- Support variable to room id 80 |
Version 0.6.1 (Jan 14, 2015)
82 |-
83 |
- Bugfix: Failed to serialize 84 |
Cron Column
\nView column showing the cron trigger expressions that can be configured on a job
(Subversion, Scheduled Builds, etc.)This is a ListViewColumn plugin that adds a column to a jobs overview page.
The column displays the cron-like expression of each Trigger that can be configured on a job (Subversion, Scheduled Builds etc).
Plugin Source: https://hudson.dev.java.net/svn/hudson/trunk/hudson/plugins/cron_column
\n ![](\"https://wiki.jenkins.io/download/attachments/43712750/Hudson%20Plugin%20-%20Cron%20Column.jpg?version=1&modificationDate=1271470566000&api=v2\")
How to Use
\nOnce you have installed this plugin, you still have to update a view to add this column. The pages Changing the Columns of a View and Editing or Replacing the All View will show you how.
\nChangelog
\nVersion 1.4 (Jun 16 2014)
\nSame as 1.1, just released to make sure it is considered newer than 1.003 (a nonstandard version string).
\nVersion 1.1 (Jun 12 2014)
\n- \n
- Do not show column by default (JENKINS-23159) \n
Version 1.003 (6 Jul, 2010)
\n- \n
- Plugin now works with other project types (previously only worked with Freestyle Projects) \n
HTML5 Notifier Plugin
\nProvides W3C Web Notifications support for builds.
\nBrowser compatibility
\nThis plugin is compatible with Google Chrome, Safari, and Firefox
\nOther browsers do not support HTML5 notifications right now. You can check this website for details : http://caniuse.com/#feat=notifications
\nScreenshots
\n\n \n \n
\n
\nSafari Notification | \n | \n
|---|---|
System Configuration | \n | \n
Job Configuration | \n | \n
![](\"https://wiki.jenkins.io/download/thumbnails/58917110/screenshot-notifications-1.3.png?version=1&modificationDate=1407001198000&api=v2\")
![](\"https://wiki.jenkins.io/download/thumbnails/58917110/screenshot-configure-1.1.png?version=1&modificationDate=1328215062000&api=v2\")
![](\"https://wiki.jenkins.io/download/thumbnails/58917110/screenshot-job-configure-1.1.png?version=1&modificationDate=1328215063000&api=v2\")
\n
Changelog
\n1.5 (released 2015-03-06)
\n- \n
- JENKINS-27222 - Fixes global configuration not saving/loading. \n
1.3 (released 2014-08-01)
\n- \n
- JENKINS-16236 - upgrade to use current html5 notification spec. Removes html in the notifications but now works again. \n
1.2 (released 2012-04-06)
\n- \n
- updated minimum required core to v1.455 to pick up prototype.js:1.7 \n
- JENKINS-13138 - Verify action doesn't work with CSRF option \n
- JENKINS-13322 - Configure tab freezes when using both the HTML5 notifier plugin and the Android Emulator Plugin \n
- JENKINS-12538 - java.lang.String cannot be cast to net.sf.json.JSONArray \n
- JENKINS-13038 - HTML5 notifier plugin breaks Jenkins with CSRF protection \n
1.1 (released 2012-02-02)
\n- \n
- JENKINS-11618 - prototype.js \n
- added per-job job property to skip notifications \n
- added ability to only notify on different build result than previous \n
- cleaned up the notification area html \n
1.0 (released 2011-10-19)
\n- \n
- initial implementation \n
- fully I18N compliant \n
\n
Plugin Information | \n
|---|
View GitHub on the plugin site for more information. | \n
\n \n
\n\n\n
\nOlder versions of this plugin may not be safe to use. Please review the following warnings before using an older version:
\n \nGithub Plugin
\nThis plugin integrates Jenkins with Github projects.The plugin currently has three major functionalities:
\n- \n
- Create hyperlinks between your Jenkins projects and GitHub \n
- Trigger a job when you push to the repository by groking HTTP POSTs from post-receive hook and optionally auto-managing the hook setup. \n
- Report build status result back to github as Commit Status (documented on SO) \n
- Base features for other plugins \n
\n
\n\nHyperlinks between changes
\nThe Github plugin decorates Jenkins \"Changes\" pages to create links to your Github commit and issue pages. It adds a sidebar link that links back to the Github project page.
\n![](\"https://wiki.jenkins.io/download/thumbnails/37749162/changes.png?version=1&modificationDate=1244761866000&api=v2\")
![](\"https://wiki.jenkins.io/download/thumbnails/37749162/changes-2.png?version=1&modificationDate=1244761881000&api=v2\")
When creating a job, specify that is connects to git. Under \"Github project\", put in: git@github.com:Person/Project.git Under \"Source Code Management\" select Git, and put in git@github.com:Person/Project.git
\nGitHub hook trigger for GITScm polling
\nThis feature enables builds after post-receive hooks in your GitHub repositories. This trigger only kicks git-plugin internal polling algo for every incoming event against matched repo.
\n\n
\nOld name
\n \n\n
\nPreviously named as \"Build when a change is pushed to GitHub\"
\nTo be able to use this feature:
\nManual Mode
\nIn this mode, you'll be responsible for registering the hook URLs to GitHub. Click the ![\"(question)\"](\"https://wiki.jenkins.io/s/en_GB/8100/5084f018d64a97dc638ca9a178856f851ea353ff/_/images/icons/emoticons/help_16.svg\"){kind=icon}
icon (under Manage Jenkins > Configure System > GitHub) to see the URL in Jenkins that receives the post-commit POSTs — but in general the URL is of the form $JENKINS_BASE_URL/github-webhook/ — for example: https://ci.example.com/jenkins/github-webhook/.
Once you have the URL, and have added it as a webhook to the relevant GitHub repositories, continue to Step 3.
\nAutomatic Mode (Jenkins manages hooks for jobs by itself)
\nIn this mode, Jenkins will automatically add/remove hook URLs to GitHub based on the project configuration in the background. You'll specify GitHub OAuth token so that Jenkins can login as you to do this.
\nStep 1. Go to the global configuration and add GitHub Server Config.
\n![](\"https://wiki.jenkins.io/download/thumbnails/37749162/ghserver-config.png?version=1&modificationDate=1441295981000&api=v2\")
Step 2.1. Create your personal access token in GitHub.
\nPlugin can help you to do it with all required scopes. Go to Advanced -> Manage Additional GitHub Actions -> Convert Login and Password to token
\n![](\"https://wiki.jenkins.io/download/thumbnails/37749162/manage-token.png?version=1&modificationDate=1441297409000&api=v2\")
\n
\nTwo-Factor Authentication
\n \n\n
\nAuto-creating token doesn't work with GitHub 2FA
\nYou can create \"Secret text\" credentials with token in corresponding domain with login and password directly, or from username and password credentials.
\nStep 2.2. Select previously created \"Secret Text\" credentials with GitHub OAuth token.
\n\n
\nRequired scopes for token
\n \n\n
\nTo be able manage hooks your token should have admin:org_hook scope.
\n\n
\nGitHub Enterprise
\n \n\n
\nYou can also redefine GitHub url by clicking on Custom GitHub API URL checkbox.
Note that credentials are filtered by entered GH url with help of domain requirements. So you can create credentials in different domains and see only credentials that matched by predefined domains.
![](\"https://wiki.jenkins.io/download/thumbnails/37749162/secret-text.png?version=1&modificationDate=1441295988000&api=v2\")
Step 3. Once that configuration is done, go to the project config of each job you want triggered automatically and simply check \"Build when a change is pushed to GitHub\" under \"Build Triggers\". With this, every new push to the repository automatically triggers a new build.
\nNote that there's only one URL and it receives all post-receive POSTs for all your repositories. The server side of this URL is smart enough to figure out which projects need to be triggered, based on the submission.
\nSecurity Implications
\nThis plugin requires that you have an HTTP URL reachable from GitHub, which means it's reachable from the whole internet. So it is implemented carefully with the possible malicious fake post-receive POSTS in mind. To cope with this, upon receiving a POST, Jenkins will talk to GitHub to ensure the push was actually made.
\nJenkins inside a firewall
\nIn case your Jenkins run inside the firewall and not directly reachable from the internet, this plugin lets you specify an arbitrary endpoint URL as an override in the automatic mode. The plugin will assume that you've set up reverse proxy or some other means so that the POST from GitHub will be routed to the Jenkins.
\nTrouble-shooting hooks
\nIf you set this up but build aren't triggered, check the following things:
\n- \n
- Click the \"admin\" button on the GitHub repository in question and make sure post-receive hooks are there.\n
- \n
- If it's not there, make sure you have proper credential set in the Jenkins system config page. \n
\n - Also, enable logging for the class names\n
- \n
com.cloudbees.jenkins.GitHubPushTrigger\n org.jenkinsci.plugins.github.webhook.WebhookManager\n com.cloudbees.jenkins.GitHubWebHook
and you'll see the log of Jenkins trying to install a post-receive hook. \n
\n - Click \"Test hook\" button from the GitHub UI and see if Jenkins receive a payload. \n
Using cache to GitHub requests
\nEach GitHub Server Config creates own GitHub client to interact with api. By default it uses cache (with 20MB limit) to speedup process of fetching data and reduce rate-limit consuming. You can change cache limit value in \"Advanced\" section of this config item. If you set 0, then this feature will be disabled for this (and only this) config.
\n\n \n
\n\n
\nAdditional info:
\n- \n
- This plugin now serves only hooks from github as main feature. Then it starts using git-plugin to fetch sources. \n
- It works both public and Enterprise GitHub \n
- Plugin have some limitations \n
Possible Issues between Jenkins and GitHub
\nWindows:
\n- \n
- In windows, Jenkins will use the the SSH key of the user it is running as, which is located in the %USERPROFILE%\\.ssh folder ( on XP, that would be C:\\Documents and Settings\\USERNAME\\.ssh, and on 7 it would be C:\\Users\\USERNAME\\.ssh). Therefore, you need to force Jenkins to run as the user that has the SSH key configured. To do that, right click on My Computer, and hit \"Manage\". Click on \"Services\". Go to Jenkins, right click, and select \"Properties\". Under the \"Log On\" tab, choose the user Jenkins will run as, and put in the username and password (it requires one). Then restart the Jenkins service by right clicking on Jenkins (in the services window), and hit \"Restart\". \n
- Jenkins does not support passphrases for SSH keys. Therefore, if you set one while running the initial Github configuration, rerun it and don't set one. \n
Pipeline examples
\nSetting commit status
\nThis code will set commit status for custom repo with configured context and message (you can also define same way backref)
\n\n
\n \n
\nvoid setBuildStatus(String message, String state) {\n step([\n $class: \"GitHubCommitStatusSetter\",\n reposSource: [$class: \"ManuallyEnteredRepositorySource\", url: \"https://github.com/my-org/my-repo\"],\n contextSource: [$class: \"ManuallyEnteredCommitContextSource\", context: \"ci/jenkins/build-status\"],\n errorHandlers: [[$class: \"ChangingBuildStatusErrorHandler\", result: \"UNSTABLE\"]],\n statusResultSource: [ $class: \"ConditionalStatusResultSource\", results: [[$class: \"AnyBuildResult\", message: message, state: state]] ]\n ]);\n}\n\nsetBuildStatus(\"Build complete\", \"SUCCESS\");\n \n More complex examle (can be used with multiply scm sources in pipeline)
\n\n
\n \n
\ndef getRepoURL() {\n sh \"git config --get remote.origin.url > .git/remote-url\"\n return readFile(\".git/remote-url\").trim()\n}\n\ndef getCommitSha() {\n sh \"git rev-parse HEAD > .git/current-commit\"\n return readFile(\".git/current-commit\").trim()\n}\n\ndef updateGithubCommitStatus(build) {\n // workaround https://issues.jenkins-ci.org/browse/JENKINS-38674\n repoUrl = getRepoURL()\n commitSha = getCommitSha()\n\n step([\n $class: 'GitHubCommitStatusSetter',\n reposSource: [$class: \"ManuallyEnteredRepositorySource\", url: repoUrl],\n commitShaSource: [$class: \"ManuallyEnteredShaSource\", sha: commitSha],\n errorHandlers: [[$class: 'ShallowAnyErrorHandler']],\n statusResultSource: [\n $class: 'ConditionalStatusResultSource',\n results: [\n [$class: 'BetterThanOrEqualBuildResult', result: 'SUCCESS', state: 'SUCCESS', message: build.description],\n [$class: 'BetterThanOrEqualBuildResult', result: 'FAILURE', state: 'FAILURE', message: build.description],\n [$class: 'AnyBuildResult', state: 'FAILURE', message: 'Loophole']\n ]\n ]\n ])\n}\n \n Change Log
\n\nOpen Issues
\n\n
\n
\n","url":"https://wiki.jenkins-ci.org/display/JENKINS/Github+Plugin"}}
--------------------------------------------------------------------------------
/public/vendor/bootstrap.min.js:
--------------------------------------------------------------------------------
1 | /*!
2 | * Bootstrap v4.3.1 (https://getbootstrap.com/)
3 | * Copyright 2011-2019 The Bootstrap Authors (https://github.com/twbs/bootstrap/graphs/contributors)
4 | * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE)
5 | */
6 | !function(t,e){"object"==typeof exports&&"undefined"!=typeof module?e(exports,require("jquery"),require("popper.js")):"function"==typeof define&&define.amd?define(["exports","jquery","popper.js"],e):e((t=t||self).bootstrap={},t.jQuery,t.Popper)}(this,function(t,g,u){"use strict";function i(t,e){for(var n=0;n\n
\n
\n \n \n \n
\n
\n | T | \nKey | \nSummary | \nStatus | \nUpdated | \nCreated | \n
|---|
\n \n type,key,summary,status,updated,created true https://issues.jenkins-ci.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?jqlQuery=component+%3D+github-plugin+AND+status+in+%28Open%2C+%22In+Progress%22%2C+Reopened%29+ORDER+BY+updated+DESC&tempMax=1000 columns=type,key,summary,status,updated,created|anonymous=true|url=https://issues.jenkins-ci.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?jqlQuery=component+%3D+github-plugin+AND+status+in+%28Open%2C+%22In+Progress%22%2C+Reopened%29+ORDER+BY+updated+DESC&tempMax=1000 BLOCK \" data-pageid=\"37749162\"> \n
\n \n \n
Refresh \n
\n
\n'}),Ze=l({},Be.DefaultType,{content:"(string|element|function)"}),tn="fade",en="show",nn=".popover-header",on=".popover-body",rn={HIDE:"hide"+ze,HIDDEN:"hidden"+ze,SHOW:"show"+ze,SHOWN:"shown"+ze,INSERTED:"inserted"+ze,CLICK:"click"+ze,FOCUSIN:"focusin"+ze,FOCUSOUT:"focusout"+ze,MOUSEENTER:"mouseenter"+ze,MOUSELEAVE:"mouseleave"+ze},sn=function(t){var e,n;function i(){return t.apply(this,arguments)||this}n=t,(e=i).prototype=Object.create(n.prototype),(e.prototype.constructor=e).__proto__=n;var o=i.prototype;return o.isWithContent=function(){return this.getTitle()||this._getContent()},o.addAttachmentClass=function(t){g(this.getTipElement()).addClass($e+"-"+t)},o.getTipElement=function(){return this.tip=this.tip||g(this.config.template)[0],this.tip},o.setContent=function(){var t=g(this.getTipElement());this.setElementContent(t.find(nn),this.getTitle());var e=this._getContent();"function"==typeof e&&(e=e.call(this.element)),this.setElementContent(t.find(on),e),t.removeClass(tn+" "+en)},o._getContent=function(){return this.element.getAttribute("data-content")||this.config.content},o._cleanTipClass=function(){var t=g(this.getTipElement()),e=t.attr("class").match(Ge);null!==e&&0