{"id":19359171,"url":"https://github.com/opslevel/jenkins-opslevel-plugin","last_synced_at":"2025-06-20T01:08:29.335Z","repository":{"id":46566564,"uuid":"371490260","full_name":"OpsLevel/jenkins-opslevel-plugin","owner":"OpsLevel","description":"Jenkins plugin to notify OpsLevel about successful deploys from Jenkins projects and builds.","archived":false,"fork":false,"pushed_at":"2025-04-21T21:14:14.000Z","size":696,"stargazers_count":0,"open_issues_count":5,"forks_count":6,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-23T11:40:18.378Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OpsLevel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-05-27T20:00:28.000Z","updated_at":"2025-02-03T16:42:36.000Z","dependencies_parsed_at":"2024-11-18T19:38:04.549Z","dependency_job_id":"57ec4391-574c-41fe-b0ff-2004c0458a3c","html_url":"https://github.com/OpsLevel/jenkins-opslevel-plugin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/OpsLevel/jenkins-opslevel-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpsLevel%2Fjenkins-opslevel-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpsLevel%2Fjenkins-opslevel-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpsLevel%2Fjenkins-opslevel-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpsLevel%2Fjenkins-opslevel-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OpsLevel","download_url":"https://codeload.github.com/OpsLevel/jenkins-opslevel-plugin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpsLevel%2Fjenkins-opslevel-plugin/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260857416,"owners_count":23073439,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T07:14:17.758Z","updated_at":"2025-06-20T01:08:24.324Z","avatar_url":"https://github.com/OpsLevel.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpsLevel plugin for Jenkins\n[![Overall](https://img.shields.io/endpoint?style=flat\u0026url=https%3A%2F%2Fapp.opslevel.com%2Fapi%2Fservice_level%2F_ZFHfdnK9K5lBrdYKUY2XNKD-myqG3y2qsgkl_MK0eY)](https://app.opslevel.com/services/jenkins_plugin/maturity-report)\n\nProvides Jenkins integration with OpsLevel. This allows you to notify OpsLevel when a deploy succeeds.\n\n# Getting started\n## Add a Jenkins Integration in OpsLevel\n1. Get an OpsLevel account \u003chttps://www.opslevel.com\u003e\n1. In the OpsLevel app, Click **Integrations** in the left sidebar\n1. Click on the **+ New Integration** button\n1. Add the **Jenkins Integration**\n![Jenkins Integration](docs/images/jenkins_integration.png)\n\n## Install the Jenkins plugin\n1. From your Jenkins home page, navigate to **Manage Jenkins**\n1. Navigate to **Manage Plugins**\n1. Change the tab to **Available**\n1. Search for 'opslevel'\n1. Check the box next to install \u0026 install the plugin\n\n## Jenkins Configuration\n### Global Configuration\n1. From your Jenkins home page, navigate to **Manage Jenkins**\n1. Navigate to **Configure System**\n1. Find the **Global OpsLevel Integration** section\n1. In the OpsLevel App, copy the webhook URL from the **Jenkins Integration** we made:\n![Jenkins Integration Webhook URL](docs/images/jenkins_integration_webhook_url.png)\n1. paste it into the **Deploy Webhook URL** box:\n![Jenkins Global Configuration](docs/images/opslevel_global_configuration.png)\n1. Click Save\n\nOpsLevel will now be notified after every successful build!\n\nIf you need more fine grained control, you can override the notification parameters from within your builds/pipelines. Importantly, if you don't want to notify every single build, you could uncheck the **Notify for all builds** checkbox in the Global Configuration and just add build steps to the builds you care about. Similarly, if there only a few builds that you want to mute, you could enable notifications globally and override specific builds to not run. Here's a look at what the configuration looks like for both pipelines and freestyle jobs:\n\n### Pipeline Configuration\n  1. Navigate to your job and click **Configure** in the left sidebar\n  1. Add an `opsLevelNotifyParams` post step with the desired parameter overrides:\n  ![Jenkins Pipeline Configuration](docs/images/opslevel_pipeline_configuration.png)\n  1. Here's an example of the parameters you can override:\n```\n  opsLevelNotifyParams(\n    webhookUrl: \"https://app.opslevel.com/integrations/deploy/3e06d761-0347-4741-a617-XXXXXXXXXXX\",\n    serviceAlias: \"catalog_service\",\n    environment: \"Staging\",\n    description: \"Test Description\",\n    deployUrl: \"\",\n    deployerId: \"\",\n    deployerEmail: \"\",\n    deployerName: \"Jenkins Test Deploy\",\n    run: true\n  )\n```\n\n### Freestyle Job Configuration\n  1.  Navigate to your job and click **Configure** in the left sidebar\n  1.  Add our post-build action **Publish successful build to OpsLevel**\n  1.  You can override notification parameters here:\n  ![Jenkins Configuration](docs/images/opslevel_post_build_action.png)\n\n\n# Developer Instructions\n\nRefer to jenkins plugin guidelines: [contribution guidelines](https://github.com/jenkinsci/.github/blob/master/CONTRIBUTING.md)\n\nInstall Maven and JDK.\n\n```shell\n$ mvn -version | grep -v home\nApache Maven 3.8.1 (05c21c65bdfed0f71a2f2ada8b84da59348c4c5d)\nJava version: 15.0.2, vendor: N/A, runtime: /usr/local/Cellar/openjdk/15.0.2/libexec/openjdk.jdk/Contents/Home\nDefault locale: en_CA, platform encoding: UTF-8\nOS name: \"mac os x\", version: \"10.15.7\", arch: \"x86_64\", family: \"mac\"\n```\n\nRun unit tests\n\n```shell\nmvn test\n```\n\n## Create plugin package\nCreate an HPI file to install in Jenkins\n\n```shell\nmvn clean package\n```\n\n## Running Locally\n\nClone this repo, install Java \u0026 Maven, run this, and open `http://localhost:8080/jenkins/` in your browser.\n```\n    env -i PATH=$PATH mvn hpi:run\n```\nThat optional `env -i PATH=$PATH` removes all env vars except `PATH`.\n\n## LICENSE\n\nLicensed under MIT, see [LICENSE](LICENSE.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopslevel%2Fjenkins-opslevel-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopslevel%2Fjenkins-opslevel-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopslevel%2Fjenkins-opslevel-plugin/lists"}