From a1d0b8b986cd0d6d3e1d2ff9bd312b40621d5ab8 Mon Sep 17 00:00:00 2001 From: Petr Šplíchal Date: Oct 06 2017 10:50:25 +0000 Subject: [PATCH 1/3] Initial version of the How to start documentation Draft created by Serhii Turivnyi. --- diff --git a/start.md b/start.md new file mode 100644 index 0000000..6306ef6 --- /dev/null +++ b/start.md @@ -0,0 +1,62 @@ +## How to start contributing to CI tests Fedora Atomic Host +To start contributing you have to read following pages in the first place: + + + +All tests are locating here: + + +To start contributing you have to create an account here: + + +Follow the guide and get access: + + +Also, create account on fedorapeople.org + + +### Remote pull-request workaround + +You can clone tests from https://upstreamfirst.fedorainfracloud.org/ +[Run them](https://fedoraproject.org/wiki/CI/Tests#Testing_an_Atomic_Host). Be sure that all tests Classic and Container are Passed. + +Navigate to the https://src.fedoraproject.org/browse/projects/ +And clone project you like to port test. + +Move tests into the project folder. Rename folder with tests to "tests" +Make sure you don\'t have ** \*.log ** files inside +Don't forget to delete **.git/** folder from tests. +Make changes, create new git branch, for example, **new_tests** + +```sh +$ git checkout -b +``` +Make commit. +Use following commit message: +#### Commit Message + +![Commit Message](https://cdn.pbrd.co/images/GNvjJ45.png) + +Upload package folder to the [Fedorapeople](https://fedorapeople.org/) +```sh +# scp -r / @fedorapeople.org:public_git/ +``` + +Navigate to the [fedoraproject.org](https://src.fedoraproject.org/rpms/pam/pull-requests) +Press **File Pull Request** button then press **Remote pull request** +![](https://cdn.pbrd.co/images/GNvkC6F.png) + +In the **Title** field paste: *Add CI tests using the standard test interface* +**Git repo address** put: *git://fedorapeople.org/~/* +**Git branch:** *new_tests* as was mentioned before +**To branch:** *master* +![](https://cdn.pbrd.co/images/GNvlULn.png) +Then press the **Preview** button +After that add **Initial Comment** with tests results, for example: + +## Initial Comment +*** +![Initial Comment](https://cdn.pbrd.co/images/GNvbmFl.png) +*** + +Make sure you mentioned right maintainer contact person. From e00844cc5d2a8dadc2c628a109bcefeb0533ac6a Mon Sep 17 00:00:00 2001 From: Petr Šplíchal Date: Oct 10 2017 09:48:02 +0000 Subject: [PATCH 2/3] Fix links, use bullets to better structure steps --- diff --git a/start.md b/start.md index 6306ef6..fc4fb67 100644 --- a/start.md +++ b/start.md @@ -1,60 +1,76 @@ -## How to start contributing to CI tests Fedora Atomic Host -To start contributing you have to read following pages in the first place: - - +## Contributing tests for Fedora Atomic Host CI -All tests are locating here: - +To start contributing you should read the following pages in the +first place: -To start contributing you have to create an account here: - + * https://fedoraproject.org/wiki/Changes/InvokingTests + * https://fedoraproject.org/wiki/CI/Tests#Testing_an_Atomic_Host -Follow the guide and get access: - +Tests from the Upstream First initiative are located here: -Also, create account on fedorapeople.org - + * https://upstreamfirst.fedorainfracloud.org/browse/projects/ -### Remote pull-request workaround +Create a FAS account and follow instructions for creating a public +git repo on fedorapeople: -You can clone tests from https://upstreamfirst.fedorainfracloud.org/ -[Run them](https://fedoraproject.org/wiki/CI/Tests#Testing_an_Atomic_Host). Be sure that all tests Classic and Container are Passed. + * https://admin.fedoraproject.org/accounts/user/new + * https://fedoraproject.org/wiki/Infrastructure/fedorapeople.org#fedora_people_git_hosting_support -Navigate to the https://src.fedoraproject.org/browse/projects/ -And clone project you like to port test. +You can also find some useful information related to packaging here: -Move tests into the project folder. Rename folder with tests to "tests" -Make sure you don\'t have ** \*.log ** files inside -Don't forget to delete **.git/** folder from tests. -Make changes, create new git branch, for example, **new_tests** + * https://fedoraproject.org/wiki/Package_maintenance_guide -```sh -$ git checkout -b -``` -Make commit. -Use following commit message: -#### Commit Message +### Pull Request + +Here are the steps for creating a pull request with new test +coverage. Clone repositories with tests and project code. + + * Clone tests from https://upstreamfirst.fedorainfracloud.org/ + * [Run them](https://fedoraproject.org/wiki/CI/Tests#Testing_an_Atomic_Host) + * Make sure sure that all tests with Atomic tag are Passed. + * Clone project from https://src.fedoraproject.org/browse/projects/ + +Include tests into the project: + + * Move tests into the project folder. + * Rename folder with tests to "tests". + * Make sure there are no ** \*.log ** files inside. + * Don't forget to delete the **.git/** folder. + * Make changes, create a new git branch, eg. `git checkout -b new_tests`. + * Commit (include links to the project in the commit links). + +Example Commit Message: -![Commit Message](https://cdn.pbrd.co/images/GNvjJ45.png) + Add CI tests using the standard test interface + + Adding tests according to the CI wiki [0] and standard test interface [1] + [0] https://fedoraproject.org/wiki/CI + [1] https://fedoraproject.org/wiki/Changes/InvokingTests + +Upload package folder to the [Fedorapeople](https://fedorapeople.org/): -Upload package folder to the [Fedorapeople](https://fedorapeople.org/) ```sh -# scp -r / @fedorapeople.org:public_git/ +scp -r ./ @fedorapeople.org:public_git/ ``` -Navigate to the [fedoraproject.org](https://src.fedoraproject.org/rpms/pam/pull-requests) -Press **File Pull Request** button then press **Remote pull request** +Navigate to the [fedoraproject.org](https://src.fedoraproject.org/rpms/pam/pull-requests). +Press **File Pull Request** button then press **Remote pull request**. + ![](https://cdn.pbrd.co/images/GNvkC6F.png) -In the **Title** field paste: *Add CI tests using the standard test interface* -**Git repo address** put: *git://fedorapeople.org/~/* -**Git branch:** *new_tests* as was mentioned before -**To branch:** *master* +Fill the required fields: + + * **Title:** *Add CI tests using the standard test interface* + * **Git repo address:** *git://fedorapeople.org/~/* + * **Git branch:** *new_tests* + * **To branch:** *master* + ![](https://cdn.pbrd.co/images/GNvlULn.png) -Then press the **Preview** button -After that add **Initial Comment** with tests results, for example: -## Initial Comment + * Press the **Preview** button. + * Add **Initial Comment** with tests results, for example: + +### Initial Comment *** ![Initial Comment](https://cdn.pbrd.co/images/GNvbmFl.png) *** From 0c58df0cc6e5c725cd1bb9ed13f441a6f83c87fc Mon Sep 17 00:00:00 2001 From: Petr Šplíchal Date: Oct 11 2017 12:41:12 +0000 Subject: [PATCH 3/3] Clarify the pull request, some adjustments --- diff --git a/start.md b/start.md index fc4fb67..7eccd26 100644 --- a/start.md +++ b/start.md @@ -1,33 +1,27 @@ ## Contributing tests for Fedora Atomic Host CI +### Documentation and Account + To start contributing you should read the following pages in the first place: * https://fedoraproject.org/wiki/Changes/InvokingTests * https://fedoraproject.org/wiki/CI/Tests#Testing_an_Atomic_Host -Tests from the Upstream First initiative are located here: - - * https://upstreamfirst.fedorainfracloud.org/browse/projects/ - -Create a FAS account and follow instructions for creating a public -git repo on fedorapeople: +Make sure you have a FAS account. You can also find useful +information and tools related to working with packages in the +Package maintenance guide: * https://admin.fedoraproject.org/accounts/user/new - * https://fedoraproject.org/wiki/Infrastructure/fedorapeople.org#fedora_people_git_hosting_support - -You can also find some useful information related to packaging here: - * https://fedoraproject.org/wiki/Package_maintenance_guide -### Pull Request +### Adding Tests -Here are the steps for creating a pull request with new test -coverage. Clone repositories with tests and project code. +Clone repositories with tests and project code, run the tests: * Clone tests from https://upstreamfirst.fedorainfracloud.org/ * [Run them](https://fedoraproject.org/wiki/CI/Tests#Testing_an_Atomic_Host) - * Make sure sure that all tests with Atomic tag are Passed. + and make sure sure that all tests with Atomic tag are Passed. * Clone project from https://src.fedoraproject.org/browse/projects/ Include tests into the project: @@ -47,12 +41,15 @@ Example Commit Message: [0] https://fedoraproject.org/wiki/CI [1] https://fedoraproject.org/wiki/Changes/InvokingTests -Upload package folder to the [Fedorapeople](https://fedorapeople.org/): +### Pull Request + +Unless you are a Fedora packager follow instructions for creating a public git repo on +[fedorapeople](https://fedoraproject.org/wiki/Infrastructure/fedorapeople.org#fedora_people_git_hosting_support) +and upload package folder there: ```sh -scp -r ./ @fedorapeople.org:public_git/ +scp -r @fedorapeople.org:public_git/ ``` - Navigate to the [fedoraproject.org](https://src.fedoraproject.org/rpms/pam/pull-requests). Press **File Pull Request** button then press **Remote pull request**.