Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/frantjc/jenkins-job-resource
Concourse resource for Jenkins jobs.
https://github.com/frantjc/jenkins-job-resource
concourse concourse-ci concourse-ci-resource concourse-resource jenkins
Last synced: 4 days ago
JSON representation
Concourse resource for Jenkins jobs.
- Host: GitHub
- URL: https://github.com/frantjc/jenkins-job-resource
- Owner: frantjc
- License: mit
- Created: 2020-11-24T20:51:44.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-07-31T08:48:15.000Z (over 1 year ago)
- Last Synced: 2024-06-21T02:16:04.526Z (5 months ago)
- Topics: concourse, concourse-ci, concourse-ci-resource, concourse-resource, jenkins
- Language: Go
- Homepage:
- Size: 131 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jenkins-job-resource [](https://github.com/frantjc/jenkins-job-resource/actions) [](https://pkg.go.dev/github.com/frantjc/jenkins-job-resource) [](https://goreportcard.com/report/github.com/frantjc/jenkins-job-resource) 
A Concourse resource for Jenkins jobs.
## Example
```yaml
resource_types:
- name: jenkins-job-resource
type: registry-image
source:
repository: ghcr.io/frantjc/jenkins-job-resource
tag: latest
resources:
- name: my-jenkins-job
type: jenkins-job-resource
source:
jobs:
- name: some-job
plan:
- put: my-jenkins-job
params:
cause: some-job in Concourse caused this build
build_params:
foo: bar
- name: another-job
plan:
- get: my-jenkins-job
```
## Source Configuration
| Parameter | Required | Example | Description |
| ----------- | ------------------- | ------------------------ | ---------------------------------------------------------------------- |
| `url` | yes | `https://my-jenkins.com` | the base url for a Jenkins deployment |
| `job` | yes | | the job name in the Jenkins deployment at the given url |
| `token` | for `put` | _see below (1)_ | the `Authentication Token` for the given job |
| `username` | unknown, but likely | | a username that can be used to authorize with the given Jenkins url |
| `login` | unknown, but likely | | either the password or an api token associated with the given username |
> _Note: if_ `login` _is set, then surely_ `username` _must be set to a corresponding username for it to have any effect. It is unknown if a Jenkins deployment can be configured such that both_ `username` _and_ `login` _are not required_
> _(1) the above can be found at_ `$YOUR_JENKINS` \> `$YOUR_JOB` \> Configure
## Behavior
### `check`
Produces new versions for all builds (after the last version) ordered by the build number
### `in`
| Parameter | Required | Example | Description |
| ---------------- | -------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `accept_results` | no | `[SUCCESS]` | array of acceptable results of the build. The step will fail if none match. Empty arrays are ignored |
| `regexp` | no | `[path/to/output.*]` | limits downloaded artifacts to only those that match one of the given patterns. Hidden files (ex: `.git`) will be ignored |
| `skip_download` | no | | whether or not to download any of the artifacts at all. Overrides `regexp`. Default `false` |
Optionally gets the specified artifacts outputted by the most recent build
Metadata is made available at `./.metadata/name`. ex:
```
$ cat ./my-jenkins-job/.metadata/result
SUCCESS
```
### `out`
| Parameter | Required | Example | Description |
| ------------------- | -------- | --------------------- | ---------------------------------------------------------------------------------------------- |
| `cause` | no | | the cause of the build being triggered. Default `caused by $ATC_EXTERNAL_URL/builds/$BUILD_ID` |
| `cause_file` | no | `path/to/cause` | path to a file containing the cause of the build being triggered |
| `description` | no | | the description of the build. Default `build triggered by $ATC_EXTERNAL_URL/builds/$BUILD_ID` |
| `description_file` | no | `path/to/description` | path to a file containing the description of the build |
| `build_params` | no | any object | name-value pairs that will be passed to the build as build parameters |
Triggers a new build of the target job and gets the result
## developing
- `make` is recommended - version 3.81 is tested
- `golang` is _required_ - version 1.18.x or above is required for [generics](https://go.dev/doc/tutorial/generics)
- `docker` is _required_ - version 20.10.x is tested