Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix grammar in README.md and DEVELOPER.md #221

Merged
merged 2 commits into from
Nov 4, 2019
Merged

Fix grammar in README.md and DEVELOPER.md #221

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
22a66d3
Added new badges, fixed grammary in README.md and DEVELOPER.md #hackt…
cgrigel Oct 29, 2019
5e17313
Removed unnecessary badges from README.md #hacktoberfest
cgrigel Nov 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions DEVELOPER.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,27 +34,27 @@ Contains the configuration for the "real" pipeline job to be configured and run
* Sets the Jenkinsfile to be executed.
* Sets the specified parameters.
* (Un)Sets the script security plugin security layer.
* Schedules a build and wait for the finalisation, redirecting the logs to the system output.
* Schedules a build and wait for the finalization, redirecting the logs to the system output.

## `payload-dependencies` module

The `payload` module depends on the presence of many other plugins,
but they are only used during the compilation and therefore are not shipped to runtime.

Having all the dependencies under payload-dependencies makes it easier to exclude
them from assembly.
them from the assembly.

## `setup` module

It implements the `JenkinsfileRunnerLauncher` in charge of starting the Jenkins instance and calling the Jenkinsfile Runner
execution engine, configuring the classloader properly.

It also contains classes to implement or configure this "environment", such as a custom implementation for the Plugin Manager
or a WAR exploder in charge of exploding the WAR file and fully initialising an instance.
or a WAR exploder in charge of exploding the WAR file and fully initializing an instance.

## `vanilla-package` module

Defines the dependencies to be included into the Vanilla Docker distribution.
Defines the dependencies to be included in the Vanilla Docker distribution.

## `tests` module

Expand Down
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ This Docker image includes the minimum required set of plugins for running pipel
See the documentation below for more information.

## Usage in command-line
Jenkinsfile Runner can be run in command line or in Docker.
In case you want to run it in command line just follow these steps:
Jenkinsfile Runner can be run in the command line or in Docker.
In case you want to run it in the command line just follow these steps:

1. Download the jar file available in [artifactory](https://repo.jenkins-ci.org/webapp/#/home) or build the source code from this repository (see [contributing guidelines](./CONTRIBUTING.md))
2. Prepare the execution environment
Expand All @@ -32,7 +32,7 @@ unzip jenkins.war -d /tmp/jenkins
```

Next, create a directory and assemble all the plugins that you'd like to use with the build.
One way to do this is to run Jenkins setup wizard and install the default set of plugins.
One way to do this is to run the Jenkins setup wizard and install the default set of plugins.
This is a gap intended to be filled with [configuration as code](https://github.com/jenkinsci/configuration-as-code-plugin)
```
JENKINS_HOME=/tmp/jenkins_home java -jar jenkins.war
Expand Down