From 52f61fdb0d676a108a77e4e751a03da15ad02f08 Mon Sep 17 00:00:00 2001 From: farhaanbukhsh Date: Jul 26 2016 07:41:45 +0000 Subject: Fix 80 chars limit in thedoc --- diff --git a/doc/pagure_ci.rst b/doc/pagure_ci.rst index 3714db0..ec973cc 100644 --- a/doc/pagure_ci.rst +++ b/doc/pagure_ci.rst @@ -2,12 +2,15 @@ Pagure CI ========= -Pagure CI is a continuous integration tool using which the PR on the projects can be tested and flaged with the status of the build. +Pagure CI is a continuous integration tool using which the PR on the projects +can be tested and flaged with the status of the build. How to enable Pagure CI ======================= -* Enable the Fedmsg plugin in pagure project setting . This will emit the message to for consumer to consume it. +* Enable the Fedmsg plugin in pagure project setting . This will emit the message + to for consumer to consume it. + * Fill in the Pagure CI form with the required details. :: @@ -19,7 +22,8 @@ How to enable Pagure CI All of which are required field. -* The jenkins token is any string that you give here. The only thing that should be kept in mind that this token should be same through out. +* The jenkins token is any string that you give here. The only thing that should be + kept in mind that this token should be same through out. * This will give a POST URL which will be used for Job Notification in Jenkins @@ -27,9 +31,11 @@ How to enable Pagure CI Configuring Jenkins =================== -Jenkins configuration is the most important part of how the Pagure CI works, after you login to your Jenkins Instance. +Jenkins configuration is the most important part of how the Pagure CI works, +after you login to your Jenkins Instance. -* Go to Manage Jenkins -> Configuire Global Security and under that select 'Project-based Matrix Authorization Strategy' +* Go to Manage Jenkins -> Configuire Global Security and under that select + `Project-based Matrix Authorization Strategy` * Download the following plugins: @@ -44,7 +50,8 @@ Jenkins configuration is the most important part of how the Pagure CI works, aft * Select Freestyle Project -* Click OK and enter the name of the project, make sure the project name you filled in the Pagure CI form should match the name you entered here. +* Click OK and enter the name of the project, make sure the project name + you filled in the Pagure CI form should match the name you entered here. * Under 'Job Notification' click 'Add Endpoint' @@ -67,7 +74,8 @@ Jenkins configuration is the most important part of how the Pagure CI works, aft * Source Code Management select Git and give the URL of the pagure project -* Under Build Trigger click on Trigger build remotely and give the same token that you gave in the Pagure CI form. +* Under Build Trigger click on Trigger build remotely and give the same token + that you gave in the Pagure CI form. * Under Build -> Add build step -> Execute Shell @@ -91,17 +99,23 @@ Example Script How to install Pagure CI ======================== -Pagure CI requires `fedmsg` to run since it uses a consumer to get messages and take appropriate actions. -The dependency that is required is `fedmdg-hubs`. For that the steps are given. +Pagure CI requires `fedmsg` to run since it uses a consumer to get messages +and take appropriate actions. The dependency that is required is `fedmdg-hubs`. +For that the steps are given. + To install the dependencies required: `dnf install fedmsg-hub` -`fedmsg` apart from the consumer require a file that tells to which cosumer it should listen to. This file basically enable the consumer in PagureCI/. For doing that, we need to place this file in appropriate directory. +`fedmsg` apart from the consumer require a file that tells to which cosumer +it should listen to. This file basically enable the consumer in PagureCI/. +For doing that, we need to place this file in appropriate directory. `sudo cp pagure/fedmsg.d/pagure_ci.py /etc/fedmsg.d/` -Since the deployment is done using rpm, the next step is covered using `setup.py` which binds the consumer with the environment, this is done while building the rpm so if rpm is already built this is not explicitly required. +Since the deployment is done using rpm, the next step is covered using `setup.py` +which binds the consumer with the environment, this is done while building the rpm +so if rpm is already built this is not explicitly required. `python setup.py install` diff --git a/pagureCI/README.rst b/pagureCI/README.rst index d79ab58..ba59d88 100644 --- a/pagureCI/README.rst +++ b/pagureCI/README.rst @@ -1,8 +1,9 @@ Pagure CI ========= -This is to setup Pagure CI for development. It is assumed that all the dependencies -are resolved. It is advised to use a virtual envivironment for development. +This is to setup Pagure CI for development. It is assumed that all the +dependencies are resolved. It is advised to use a virtual envivironment +for development. * Run:: @@ -20,10 +21,12 @@ Now in pagureCI/consumer.py add the following elements in `topic` list Configuring Jenkins =================== -Jenkins configuration is the most important part of how the Pagure CI works, after you login to your Jenkins Instance. +Jenkins configuration is the most important part of how the Pagure CI works, +after you login to your Jenkins Instance. -* Go to Manage Jenkins -> Configuire Global Security and under that select 'Project-based Matrix Authorization Strategy' +* Go to Manage Jenkins -> Configuire Global Security and under that select + 'Project-based Matrix Authorization Strategy' * Add a user and give all the permission to that user. @@ -40,7 +43,8 @@ Jenkins configuration is the most important part of how the Pagure CI works, aft * Select Freestyle Project -* Click OK and enter the name of the project, make sure the project name you filled in the Pagure CI form should match the name you entered here. +* Click OK and enter the name of the project, make sure the project name you + filled in the Pagure CI form should match the name you entered here. * Under 'Job Notification' click 'Add Endpoint' @@ -63,7 +67,8 @@ Jenkins configuration is the most important part of how the Pagure CI works, aft * Source Code Management select Git and give the URL of the pagure project -* Under Build Trigger click on Trigger build remotely and give the same token that you gave in the Pagure CI form. +* Under Build Trigger click on Trigger build remotely and give the same token + that you gave in the Pagure CI form. * Under Build -> Add build step -> Execute Shell @@ -84,9 +89,12 @@ Example Script git merge --no-ff "proposed/$BRANCH" -m "Merge PR" fi -* After all the configuration done, go to the dev instance of pagure running and under project settings in `Plugin` select Pagure CI and fill the appropriate information. Which on submiting should give you a POST url. +* After all the configuration done, go to the dev instance of pagure running + and under project settings in `Plugin` select Pagure CI and fill the appropriate + information. Which on submiting should give you a POST url. -* Copy and paste the URL in the Notification section under the Jenkins project you want the CI to work, +* Copy and paste the URL in the Notification section under the Jenkins project + you want the CI to work, Get It Running: @@ -104,4 +112,7 @@ Another window: fedmsg-hub -* Now clone the project locally and make a branch. make some changes and push it to the repo and try to make a PR. You will notice if everything works fine a lot of logs in the server console and `build fail` flag on the PR. Build fail because there is no git server running. +* Now clone the project locally and make a branch. make some changes and push it + to the repo and try to make a PR. You will notice if everything works fine a lot + of logs in the server console and `build fail` flag on the PR. + Build fail because there is no git server running.