Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/snow-actions/setup-jenkins
Set up Jenkins container on GitHub Actions
https://github.com/snow-actions/setup-jenkins
actions github-actions jenkins
Last synced: 28 days ago
JSON representation
Set up Jenkins container on GitHub Actions
- Host: GitHub
- URL: https://github.com/snow-actions/setup-jenkins
- Owner: snow-actions
- License: mit
- Created: 2022-05-11T14:27:23.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-01T05:02:27.000Z (almost 2 years ago)
- Last Synced: 2024-10-09T06:53:13.516Z (about 1 month ago)
- Topics: actions, github-actions, jenkins
- Language: Dockerfile
- Homepage:
- Size: 67.4 KB
- Stars: 7
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://github.com/snow-actions/setup-jenkins/actions/workflows/test.yml)
# Setup Jenkins
Set up Jenkins container.
## Usage
1. Copy `$JENKINS_HOME/jobs/*/config.xml` from existing Jenkins to `jenkins_home/` in your repository
or you can put `jenkins_home/jenkins.yaml` if [Jenkins Configuration as Code (JCasC)](#jenkins-configuration-as-code-jcasc)
1. Create a workflow with the jenkins_home path
```yml
steps:
- uses: actions/checkout@v3
- uses: snow-actions/[email protected]
with:
jenkins_home: jenkins_home
- run: wget $JENKINS_URL/jnlpJars/jenkins-cli.jar
- run: java -jar jenkins-cli.jar -webSocket help
- run: java -jar jenkins-cli.jar -webSocket build job-1 -f -v -p param_1=p1
```
### Install plugins
Recommended plugins are installed by default.
#### Add plugins
Install plugins in addition to recommended plugins.
```yml
steps:
- uses: snow-actions/[email protected]
- run: wget $JENKINS_URL/jnlpJars/jenkins-cli.jar
- name: Short name
run: java -jar jenkins-cli.jar -webSocket install-plugin git -deploy
- name: URL
run: java -jar jenkins-cli.jar -webSocket install-plugin https://updates.jenkins.io/latest/http_request.hpi -deploy
```
#### Override plugins
Recommended plugins are not installed.
```yml
steps:
- uses: snow-actions/[email protected]
with:
plugins: |
git
http_request
```
## Inputs
See [action.yml](action.yml)
| Name | Description | Default | Required |
| - | - | - | - |
| `jenkins_image_tag` | [Jenkins image](https://hub.docker.com/r/jenkins/jenkins) tag | `lts-jdk11` | no |
| `jenkins_home` | Jenkins home path which will be
mounted to `/var/jenkins_home`.
Set `''` if you don't want to mount. | `${{ runner.temp }}/jenkins_home` | no |
| `env_file` | Jenkins container [env_file](https://docs.docker.com/compose/environment-variables/#the-env_file-configuration-option) path | - | no |
| `plugins` | Override plugins.txt
`@` installs recommended plugins. | `@` | no |
## Output environment variables
| Name | Description |
| - | - |
| `JENKINS_HOME` | Path to jenkins_home |
| `JENKINS_VERSION` | Jenkins version |
| `JENKINS_URL` | Jenkins URL: http://localhost:8080 |
| `COMPOSE_FILE` | Docker Compose variable as same as `--file`, `-f` option
You can access Jenkins container by `docker compose exec jenkins ` |
## Examples
### Workflow
See [test.yml](.github/workflows/test.yml)
### Jenkins Configuration as Code (JCasC)
See [jenkins.yaml](test-resources/jenkins.yaml)
Documents
- https://www.jenkins.io/doc/book/managing/casc/
- https://www.jenkins.io/projects/jcasc/
- https://plugins.jenkins.io/configuration-as-code/
- https://plugins.jenkins.io/configuration-as-code-groovy/
- https://plugins.jenkins.io/job-dsl/
## Supported
### Runners
- `ubuntu-22.04`
- `ubuntu-20.04`
- `self-hosted`
### Events
- Any
## Dependencies
- [Docker Compose V2](https://docs.docker.com/compose/)
- [Jenkins](https://hub.docker.com/r/jenkins/jenkins)
## Contributing
Welcome.