Skip to content

Commit

Permalink
Merge pull request #99 from oleg-nenashev/docs-migration
Browse files Browse the repository at this point in the history
Migrate documentation from Wiki to GitHub
  • Loading branch information
oleg-nenashev authored May 26, 2020
2 parents db2281a + 16b8eed commit 474a9ce
Show file tree
Hide file tree
Showing 6 changed files with 45 additions and 11 deletions.
10 changes: 0 additions & 10 deletions README.adoc

This file was deleted.

44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Chuck Norris plugin for Jenkins

[![Jenkins Plugin](https://img.shields.io/jenkins/plugin/v/chucknorris.svg)](https://plugins.jenkins.io/chucknorris)
[![GitHub release](https://img.shields.io/github/release/jenkinsci/chucknorris-plugin.svg?label=changelog)](https://github.com/jenkinsci/chucknorris-plugin/releases/latest)
[![Jenkins Plugin Installs](https://img.shields.io/jenkins/plugin/i/chucknorris.svg?color=blue)](https://plugins.jenkins.io/chucknorris)

This plugin adds an absolutely delightful feature to Jenkins:
depending if your build succeeds, fails, or is unstable,
it will show a picture of Chuck Norris *auto-adapting* (that's right, computer science it is!) to the build result!

Seeing that, already many thousands (yes, *thousands*!) of people have decided to take the plunge and install this plugin to finally see the light.
Why not you?

## Download & Installation

You can preferably install this plugin directly from the Plugins Update Center,
or if need be by downloading the [latest .hpi](http://updates.jenkins-ci.org/latest/chucknorris.hpi) and install it from the _Manage Plugins_ menu.

## Usage

1. After installing the plugin, go to job configuration page, a checkbox with the text _Activate Chuck Norris_ should appear.
2. Tick the checkbox and save the configuration.
For a freestyle job, Chuck Norris image (along with a random quote) will appear on the job page.
3. Run a build. After it's completed, Chuck Norris image (and the random quote) should also appear on the build page.
This is applicable for both Freestyle, Maven and Jenkins Pipeline jobs.

### Screenshots

![](docs/images/chucknorris_badass.jpg)
![](docs/images/chucknorris_thumbup.jpg)
![](docs/images/chucknorris_alert.jpg)

## Release Notes

See [GitHub Releases](https://github.com/jenkinsci/chucknorris-plugin/releases).

## Testimonials

- Uncle Bob Martin said ChuckNorris Plugin [is *very* motivating](http://twitter.com/unclebobmartin/statuses/10741488856).

## Credits

* [Chuck Norris 'The Programmer' facts](http://www.codesqueeze.com/the-ultimate-top-25-chuck-norris-the-programmer-jokes)
* [Emotional Jenkins Plugin](https://plugins.jenkins.io/emotional-jenkins-plugin/).
Binary file added docs/images/chucknorris_alert.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/chucknorris_badass.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/chucknorris_thumbup.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<jenkins.version>2.190.1</jenkins.version>
</properties>

<url>https://wiki.jenkins-ci.org/display/JENKINS/ChuckNorris+Plugin</url>
<url>https://github.com/jenkinsci/chucknorris-plugin</url>
<packaging>hpi</packaging>

<developers>
Expand Down

0 comments on commit 474a9ce

Please sign in to comment.