diff --git a/README.md b/README.md index 8a81136..57ee58f 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,32 @@ # Katalon Plugin for Jenkins -Katalon Plugin for Jenkins helps execute Katalon Studio in Jenkins easily. -Katalon Studio will be downloaded and deployed automatically. +Katalon Plugin for Jenkins helps integrate Katalon Studio and Katalon TestOps with Jenkins easily. Katalon Studio will be downloaded and deployed automatically. -> For Jenkins Pipeline, please use the official Docker image for Katalon Studio. -> Sample Jenkinsfile can be found [here](https://github.com/katalon-studio-samples/ci-samples/blob/master/Jenkinsfile). +## Tutorials -## Usage +To learn more about using this plugin, you can refer to the following documents: -* Install the plugin. +[Integrate Katalon Studio with Jenkins](https://docs.katalon.com/katalon-studio/docs/jenkins-integration-overview.html#jenkins-integration). -* Go to project *Configure* > *Build* > *Add build step* > *Execute Katalon Studio Tests*. +[Integrate Katalon TestOps with Jenkins](https://docs.katalon.com/katalon-analytics/docs/ka-integration-jenkins.html). -* Provide the desired Katalon Studio version and command arguments. +## Development -* Save the configuration. +Use the command `mvn clean hpi:run -Djetty.port=8090` to debug the plugin. -Optionally, you can tell Jenkins to publish the JUnit reports. +See the instructions at https://wiki.jenkins.io/display/JENKINS/Plugin+tutorial. -* Go to *Add post-build action* > *Publish JUnit test result report*. +## Companion products -* Set the value *Test report XMLs* to *Reports/**/JUnit_Report.xml*. +### Katalon TestOps -* *Latest Test Result* will be shown in the project page after every build. +[Katalon TestOps](https://analytics.katalon.com) is a web-based application that provides dynamic perspectives and an insightful look at your automation testing data. You can leverage your automation testing data by transforming and visualizing your data; analyzing test results; seamlessly integrating with such tools as Katalon Studio and Jira; maximizing the testing capacity with remote execution. -## Development - -Use the command `mvn clean hpi:run -Djetty.port=8090` to debug the plugin. +* Read our [documentation](https://docs.katalon.com/katalon-analytics/docs/overview.html). +* Ask a question on [Forum](https://forum.katalon.com/categories/katalon-analytics). +* Request a new feature on [GitHub](CONTRIBUTING.md). +* Vote for [Popular Feature Requests](https://github.com/katalon-analytics/katalon-analytics/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request+sort%3Areactions-%2B1-desc). +* File a bug in [GitHub Issues](https://github.com/katalon-analytics/katalon-analytics/issues). -See the instructions at https://wiki.jenkins.io/display/JENKINS/Plugin+tutorial. \ No newline at end of file +### Katalon Studio +[Katalon Studio](https://www.katalon.com) is a free and complete automation testing solution for Web, Mobile, and API testing with modern methodologies (Data-Driven Testing, TDD/BDD, Page Object Model, etc.) as well as advanced integration (JIRA, qTest, Slack, CI, Katalon TestOps, etc.). Learn more about [Katalon Studio features](https://www.katalon.com/features/).