Skip to content

Commit

Permalink
Clean up Jenkins doc formatting and URLs
Browse files Browse the repository at this point in the history
  • Loading branch information
macklinu committed Jun 27, 2017
1 parent 45c727c commit 423df13
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions source/ci_source/providers/Jenkins.ts
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
import { Env, CISource } from "../ci_source"
import { ensureEnvKeysExist, ensureEnvKeysAreInt } from "../ci_source_helpers"

// https://jenkins-ci.org
// https://jenkins.io/

/**
* ### CI Setup
* Ah Jenkins, so many memories. So, if you're using Jenkins, you're hosting your own environment.
* ### CI Setup
* Ah Jenkins, so many memories. So, if you're using Jenkins, you're hosting your own environment.
*
* ### GitHub
* You will want to be using the
* [GitHub pull request builder plugin](https://wiki.jenkins-ci.org/display/JENKINS/GitHub+pull+request+builder+plugin)
* in order to ensure that you have the build environment set up for PR integration.
* ### GitHub
* You will want to be using the
* [GitHub pull request builder plugin](https://wiki.jenkins.io/display/JENKINS/GitHub+pull+request+builder+plugin)
* in order to ensure that you have the build environment set up for PR integration.
*
* With that set up, you can edit your job to add `yarn danger` at the build action.
* With that set up, you can edit your job to add `yarn danger` at the build action.
*
* ### Pipeline
* ### Pipeline
* If you're using [pipelines](https://jenkins.io/solutions/pipeline/) you should be using the
* [GitHub branch source plugin](https://wiki.jenkins-ci.org/display/JENKINS/GitHub+Branch+Source+Plugin) for easy setup and handling of PRs.
* [GitHub branch source plugin](https://wiki.jenkins.io/display/JENKINS/GitHub+Branch+Source+Plugin) for easy setup and handling of PRs.
*
* After you've set up the plugin, add a `sh 'yarn danger'` line in your pipeline script and make sure that build PRs is enabled.
* After you've set up the plugin, add a `sh 'yarn danger'` line in your pipeline script and make sure that build PRs is enabled.
*
* ## Token Setup
* ## Token Setup
*
* ### GitHub
* As you own the machine, it's up to you to add the environment variable for the `DANGER_GITHUB_API_TOKEN`.
* ### GitHub
* As you own the machine, it's up to you to add the environment variable for the `DANGER_GITHUB_API_TOKEN`.
*/
export class Jenkins implements CISource {
constructor(private readonly env: Env) {}
Expand Down

0 comments on commit 423df13

Please sign in to comment.