Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 1 addition & 11 deletions demo/casc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,6 @@ CASC_JENKINS_CONFIG=config/jenkins.yaml ../../app/target/appassembler/bin/jenkin

## Running the demo in Docker

If you have not built the Docker image yet:
(Refer to the [Packaging to Docker image](../../packaging/docker/README.adoc) page for details on the
Docker packaging process)

```bash
docker build -t jenkinsfile-runner:my-production-jenkins ../..
```

Now that the image is built, run it, mounting the `config` directory:

```bash
docker run --rm -v $PWD:/workspace -v $PWD/config:/usr/share/jenkins/ref/casc jenkinsfile-runner:my-production-jenkins
docker run --rm -v $PWD:/workspace -v $PWD/config:/usr/share/jenkins/ref/casc ghcr.io/jenkinsci/jenkinsfile-runner:latest
```
2 changes: 1 addition & 1 deletion demo/declarative-pipeline/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ powered by the Jenkinsfile Runner vanilla package.
## Running in Docker

```bash
docker run --rm -v $(pwd)/Jenkinsfile:/workspace/Jenkinsfile jenkins4eval/jenkinsfile-runner:1.0-beta-11
docker run --rm -v $(pwd)/Jenkinsfile:/workspace/Jenkinsfile ghcr.io/jenkinsci/jenkinsfile-runner:latest
```

## Running (without Docker)
Expand Down
2 changes: 2 additions & 0 deletions demo/docker-simple/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Create a JFR from the jenkins/jenkins Docker image

> **WARNING:** This demo is outdated and needs to be renewed to the new version

This tutorial will show you how to use the community maintained [Jenkins container](https://github.com/jenkinsci/docker) and convert it into a working Jenkinsfile-Runner aka JFR.

The main benefit to doing it this way is that you could use the exact same Jenkins container you run in production locally on your development machine. The community image also has plenty of documentation on how to further customise the Jenkins container.
Expand Down
4 changes: 3 additions & 1 deletion demo/git-maven/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Demo: Git and Maven

Demonstrates a simple Pipeline which checks out from the Git repository and then runs a Maven build.
> **WARNING:** This demo is outdated and needs to be renewed to the new version

Demonstrates a simple Pipeline which checks out from the Git repository and then runs an Apache Maven build.

## Run with Docker

Expand Down
9 changes: 6 additions & 3 deletions demo/jenkins-templating-engine/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Jenkins Templating Engine demo

> **WARNING:** This demo is outdated and needs to be renewed to the new version

This demo shows how to use the [Jenkins Templating Engine](https://plugins.jenkins.io/ptemplating-engine/) (JTE) with Jenkinsfile Runner.

Support for Pipeline as YAML plugin is available starting from
Expand All @@ -13,10 +15,11 @@ This demo uses JCasC to configure the `libraries` directory as a library source

```bash
docker run --rm \
-v $(pwd)/Jenkinsfile:/workspace/Jenkinsfile \
-v $(pwd)/demo/jenkins-templating-engine:/workspace \
-v $(pwd):/tmp/libraries \
-v $(pwd)/demo/jenkins-templating-engine/config:/usr/share/jenkins/ref/casc \
jenkins4eval/jenkinsfile-runner:dev \
-v $(pwd)/libraries:/tmp/libraries \
-v $(pwd)/config:/usr/share/jenkins/ref/casc \
ghcr.io/jenkinsci/jenkinsfile-runner:latest \
-jte -pc /workspace/pipeline_config.groovy
```

Expand Down
12 changes: 7 additions & 5 deletions demo/job-folders/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Job Folders demo
=================

> **WARNING:** This demo is outdated and needs to be renewed to the new version

This demo shows, how to define the Job inside of a folder-structure, defined by parameter ```--job-name```
To create folders with additional behavior (e.g. loading of shared libraries), Job DSLs as JCasC can be used.

Expand All @@ -16,7 +18,7 @@ docker run --rm \
-v $(pwd)/demo/job-folders/Jenkinsfile:/workspace/Jenkinsfile \
-v $(pwd)/demo/job-folders/folderTemplate.yaml:/usr/share/jenkins/ref/casc/folderTemplate.yaml \
-v $(pwd)/vanilla-package/target/plugins:/usr/share/jenkins/ref/plugins \
jenkins4eval/jenkinsfile-runner:dev \
ghcr.io/jenkinsci/jenkinsfile-runner:latest \
--job-name folderWithoutLib/exampleJob
```

Expand All @@ -27,7 +29,7 @@ docker run --rm \
-v $(pwd)/demo/job-folders/JenkinsfileWithLibraryCall:/workspace/Jenkinsfile \
-v $(pwd)/demo/job-folders/folderTemplate.yaml:/usr/share/jenkins/ref/casc/folderTemplate.yaml \
-v $(pwd)/vanilla-package/target/plugins:/usr/share/jenkins/ref/plugins \
jenkins4eval/jenkinsfile-runner:dev \
ghcr.io/jenkinsci/jenkinsfile-runner:latest \
--job-name myFolder/myJob
```

Expand All @@ -36,7 +38,7 @@ docker run --rm \
```bash
docker run --rm \
-v $(pwd)/demo/job-folders/Jenkinsfile:/workspace/Jenkinsfile \
jenkins4eval/jenkinsfile-runner:dev \
ghcr.io/jenkinsci/jenkinsfile-runner:latest \
--job-name folder1/folder2/myJob
```

Expand All @@ -45,13 +47,13 @@ docker run --rm \
```bash
docker run --rm \
-v $(pwd)/demo/job-folders/Jenkinsfile:/workspace/Jenkinsfile \
jenkins4eval/jenkinsfile-runner:dev \
ghcr.io/jenkinsci/jenkinsfile-runner:latest \
--job-name myJob
```

## Run without defined name (with Docker)
```bash
docker run --rm \
-v $(pwd)/demo/job-folders/Jenkinsfile:/workspace/Jenkinsfile \
jenkins4eval/jenkinsfile-runner:dev
ghcr.io/jenkinsci/jenkinsfile-runner:latest
```
13 changes: 3 additions & 10 deletions demo/pipeline-as-yaml/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Pipeline as YAML demo

> **WARNING:** This demo is outdated and needs to be renewed to the new version

This demo shows how to use [Pipeline as YAML](https://plugins.jenkins.io/pipeline-as-yaml/) in Jenkinsfile Runner.
Support for Pipeline as YAML plugin is available starting from 1.0-beta-13 (and beta-14 for Vanilla Docker images).

In this demo we will execute a simple "Hello, world!" Pipeline defined as YAML.

Expand All @@ -10,13 +11,5 @@ In this demo we will execute a simple "Hello, world!" Pipeline defined as YAML.
```bash
docker run --rm \
-v $(pwd)/Jenkinsfile.yml:/workspace/Jenkinsfile.yml \
jenkins/jenkinsfile-runner
```

## Running (without Docker)

Once Jenkinsfile Runner is built locally, the demo can be launched as...

```bash
../../app/target/appassembler/bin/jenkinsfile-runner -p ../../vanilla-package/target/plugins/ -w ../../vanilla-package/target/war/jenkins.war -f ./Jenkinsfile.yml
ghcr.io/jenkinsci/jenkinsfile-runner:latest
```
2 changes: 2 additions & 0 deletions demo/pipeline-library/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Pipeline Library demo
=====================

> **WARNING:** This demo is outdated and needs to be renewed to the new version

This demo shows how to declare a Pipeline library with JCasC and to use it in the Pipeline.
Later this demo will be reworked to the native bundling.

Expand Down
5 changes: 4 additions & 1 deletion demo/pipeline-utility-steps/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,7 @@ This demo demonstrates how to use the pipeline-utility-steps

The Jenkinsfile Runner can be started simply as...

docker run --rm -v $(pwd)/Jenkinsfile:/workspace/Jenkinsfile jenkins4eval/jenkinsfile-runner
```bash
docker run --rm -v $(pwd)/Jenkinsfile:/workspace/Jenkinsfile \
ghcr.io/jenkinsci/jenkinsfile-runner:latest
```