Code Monkey home page Code Monkey logo

gitea-checks-plugin's Introduction

Gitea Checks API Plugin

Gitea Checks Plugin Cover

This plugin publishes checks to Gitea through Gitea API, while it implements the extension points defined in Checks API Plugin. It is an adapted version of the github-checks-plugin, which uses the Gitea API client from gitea-plugin.

Features

Prerequsite: Jenkins needs to have a valid Gitea server configuration with Gitea API credentials in Jenkins settings .

Build Status Check

Gitea Commit Status

This plugin implements the status checks feature from Checks API Plugin to publish statuses (pending, in progress, and completed) to Gitea.

Gitea commit status are rather simple compared to GitHub checks: Gitea commit status show the state, a check context used as a identifier for a specific check and a check description. The check context can be used in Gitea to specify required checks for a specific branch (See Gitea Branch Protection).

Gitea Branch Protection

Contributing

Refer to our contribution guidelines

Acknowledgements

Thanks to the developers of the gitea-plugin to provide the Gitea integration into Jenkins. Publishing checks to GIT providers in this way wouldn't be possible without the Jenkins ecosystem: The Checks API Plugin provides the necessary base and the github-checks-plugin provides a reference implementation. With these prerequisites it was straight forward to copy the github-checks-plugin implementation and adapt it to the more simpler Gitea.

This plugin was started as a Google Summer of Code 2020 project, special thanks to the support from Jenkins GSoC SIG and the entire community.

LICENSE

Licensed under MIT, see LICENSE

gitea-checks-plugin's People

Contributors

agaudreault avatar caellion avatar dependabot[bot] avatar flozzone avatar mrginglymus avatar nilmapeiris avatar notmyfault avatar rtyler avatar timja avatar uhafner avatar xiongkezhi avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

gitea-checks-plugin's Issues

Add documentation on how to use from jenkins

What feature do you want to see added?

I couldnt really understand how i add this to my multibranch pipeline.

It would be nice if the documentation could be improved for this.

Upstream changes

No response

how to show status on the pull request

Describe your use-case which is not covered by existing documentation.

I have tried multiple ways to show status check on a simple repo using a local Jenkins and Gitea but I couldn't dot it.
I appreciate any docs or and example on the README for beginners with this plugin.

best regards

Documentation of how to use this plugin in a Jenkinsfile

Describe your use-case which is not covered by existing documentation.

Hi,

Are there examples of how to use this plugin in a jenkinsfile? Or is there a reference for all the potential settings/arguments that can be configured?

Reference any relevant documentation, other materials or issues/pull requests that can be used for inspiration.

No response

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.