From e6e931ccfd20f11914581de27722659539ae2db3 Mon Sep 17 00:00:00 2001 From: Jana Vrbkova Date: Wed, 16 Feb 2022 10:38:16 +0100 Subject: [PATCH 01/18] editing writing style and punctuation Signed-off-by: Jana Vrbkova --- .../2022-02-16-reviewing-pull-requests.adoc | 91 +++++++++---------- 1 file changed, 43 insertions(+), 48 deletions(-) diff --git a/_posts/2022-02-16-reviewing-pull-requests.adoc b/_posts/2022-02-16-reviewing-pull-requests.adoc index 8c5e4dd0..40db7c38 100644 --- a/_posts/2022-02-16-reviewing-pull-requests.adoc +++ b/_posts/2022-02-16-reviewing-pull-requests.adoc @@ -13,23 +13,22 @@ Reviewing pull requests for a GitHub project integrated with {prod}. === Using {prod} to review pull requests -As long as you're using a supported web browser like Google Chrome, {prod} can make it possible to review a pull request (PR) without setting up runtimes, build tools, or any additional software on the local machine. +With Google Chrome, Eclipse Che makes it possible to review a pull request (PR) without setting up runtimes, build tools, or any extra software on the local machine. -This blog post will showcase the typical workflow on how PRs can be reviewed using {prod} for a GitHub project that is well-integrated with {prod}. -The GitHub project used in this blog post is located here: link:https://github.com/che-incubator/quarkus-api-example[www.github.com/che-incubator/quarkus-api-example]. +This blog post will showcase the typical workflow of reviewing PRs of a GitHub project that is well-integrated with Eclipse Che. Here is the GitHub project used in this blog post: link:https://github.com/che-incubator/quarkus-api-example[www.github.com/che-incubator/quarkus-api-example]. -Please refer to these references on how to set up your project with {prod}: +You can refer to these articles on how to set up your project with {prod}: * <<../../01/11/@ilya.buziuk-contributing-for-the-first-time-to-a-project#set-up-project,How can maintainers set up their projects to use Eclipse Che?>> * link:https://www.eclipse.org/che/docs/che-7/end-user-guide/authoring-devfiles-version-2[Authoring a devfile v2] -NOTE: It is crucial that your project contains a well-defined devfile.yaml file to make the most out of your development experience with {prod}. The devfile should define your project's development environment such as development commands, containers, endpoints etc. +NOTE: Your project must contain a well-defined devfile.yaml file to make the most out of your development experience with {prod}. Use the devfile to define your project’s development environment such as development commands, containers, endpoints, etc. -WARNING: In the following scenario devfile v2 is used and {prod} has been deployed alongside the {devworkspace} engine, which is currently not in use on link:https://workspaces.openshift.com/[Eclipse Che Hosted by Red Hat]. To open the example GitHub project on Eclipse Che Hosted by Red Hat, please use the link:https://github.com/che-incubator/quarkus-api-example/tree/devfilev1[devfilev1] branch which provides support for the deprecated devfile v1. +WARNING: The following scenario uses devfile v2, and {prod} is deployed alongside the {devworkspace} engine currently not used on link:https://workspaces.openshift.com/[Eclipse Che Hosted by Red Hat]. To open the test GitHub project on Eclipse Che Hosted by Red Hat, please use the link:https://github.com/che-incubator/quarkus-api-example/tree/devfilev1[devfilev1] branch supports the deprecated devfile v1. === The scenario -Let's imagine that we are developing a REST API with Quarkus that interacts with `Food` resources from a PostgreSQL database. +Imagine that you're developing a REST API with Quarkus that interacts with `Food` resources from a PostgreSQL database. [source,java] ---- /* Food.java */ @@ -70,100 +69,96 @@ In the current state of the project, there are four endpoints: |Creates a Food resource |=== -It looks like a "colleague" has opened a new PR that adds a new `GET` endpoint, `/food/restaurant/{restaurantName}` that retrieves a list of all `Food` resources served from a specified restaurant: +It looks like your colleague has opened a new PR that adds a new `GET` endpoint, `/food/restaurant/{restaurantName}`. The endpoint retrieves a list of all `Food`` resources served from a specified restaurant: image::/assets/img/reviewing-pull-requests/pr.png[The pull request to review] -Figure 1: The GitHub PR that we need to review. +Figure 1: The GitHub PR you need to review. -Let's review this PR by launching a new {prod} workspace. From the {prod} workspace, we can verify the PR by running unit tests, running the application, accessing the endpoint, building the application, all without leaving our web browser. +Review this PR by launching a new {prod} workspace. Here you can verify the PR by running unit tests, running the application, accessing the endpoint, and building the application, all within your web browser. -The workspace and IDE editor can be launched on link:https://www.eclipse.org/che/docs/che-7/hosted-che/hosted-che/[Eclipse Che Hosted by Red Hat] by clicking the {prod} badge from the base GitHub repository's `README`: +Launch the workspace and Web IDE editor on link:https://www.eclipse.org/che/docs/che-7/hosted-che/hosted-che/[Eclipse Che Hosted by Red Hat] by clicking the {prod} badge from the base GitHub repository's `README`: -image::/assets/img/reviewing-pull-requests/badge.png[Badge used to launch workspace] -Figure 2: A badge from the base repository's `README.md` that launches a developer workspace when clicked. +image::/assets/img/reviewing-pull-requests/badge.png[Badge used to launch workspaces] +Figure 2: Clicking on a badge from the base repository's `README.md` launches a developer workspace. === Launching a workspace and reviewing the PR image::/assets/img/reviewing-pull-requests/ide.png[The Che-theia editor] Figure 3: The Che-Theia editor. -Once the workspace has launched and the Web IDE has opened, you will see that the project has been cloned already (see the Explorer view on the bottom-right). +After you launch the workspace, the web IDE will open automatically and you'll see that the project has been cloned already (see the Explorer view on the bottom-right). + +To use the link:https://github.com/Microsoft/vscode-pull-request-github[GitHub Pull Requests and Issues] extension, you must first authenticate with GitHub by clicking on the Accounts icon on the bottom left of the editor. The extension adds the GitHub view to the sidebar and provides integration with GitHub. As a result, you can make PR comments, in-editor comments, approve PRs, and much more, all from the web IDE. -To leverage the link:https://github.com/Microsoft/vscode-pull-request-github[GitHub Pull Requests and Issues] plugin, we must first authenticate with GitHub by clicking on the Accounts icon on the bottom left of the editor. The extension adds the GitHub view to the sidebar, and provides integration with GitHub. -As a result, we can make PR comments, in-editor comments, approve PRs, and much more, all from the IDE. Click on "Sign in to user GitHub Pull Requests and Issues (1)". You will be prompted to enter your GitHub credentials to sign in. -image::/assets/img/reviewing-pull-requests/sign-in.png[The context menu that appears after clicking the Accounts icon, 600] -Figure 4: The context menu that appears after clicking the Accounts icon. +image::/assets/img/reviewing-pull-requests/sign-in.png[The context menu appears after clicking the Accounts icon, 600] +Figure 4: The context menu appears after clicking the Accounts icon. -After signing in successfully, navigate to the GitHub view from the sidebar to see an overview of PRs against the base repository. Under the "Assigned To Me" drop-down, we can see the PR that we will review. +After signing in, navigate to the GitHub view from the sidebar to see an overview of PRs against the base repository. Under the "Assigned To Me" drop-down, you can see the PR that you'll review. -image::/assets/img/reviewing-pull-requests/github-view.png[Viewing the PR within the IDE, 400] +image::/assets/img/reviewing-pull-requests/github-view.png[Viewing the PR within the web IDE, 400] Figure 5: The GitHub view, opened by clicking on the fifth icon from the top. -WARNING: If the workspace was launched with a badge generated with the link:https://github.com/marketplace/actions/try-in-web-ide[Try in Web IDE] GitHub action on PR coming from a forked repository, git remotes must be manually set up in order to use the GitHub Pull Requests and Issues plugin. Please see link:https://github.com/redhat-actions/try-in-web-ide/issues/14[redhat-actions/try-in-web-ide#14]. +WARNING: If you launch a workspace with a badge generated using the link:https://github.com/marketplace/actions/try-in-web-ide[Try in Web IDE] GitHub action on a PR from a forked repository, you must manually set up git remotes in order to use the GitHub Pull Requests and Issues extension. Please see link:https://github.com/redhat-actions/try-in-web-ide/issues/14[redhat-actions/try-in-web-ide#14]. -In the drop-down menu underneath the PR, we see a "Description" menu item, as well as a file hierarchy displaying all of the changed files in the PR. -In this case, the files that were changed were: `FoodResource.java`, `FoodEndpointTest.java` and `README.md`. Clicking on these files will open a diff view within the IDE. -Taking a look at these files, we can verify that the PR adds the new endpoint, as well as a unit test. Let's checkout the feature branch and take a closer look at the PR. +The "Description" menu item, as well as a file hierarchy with all changed files, are in the drop-down menu below the PR. In this case, the changed files are FoodResource.java, FoodEndpointTest.java, and README.md. Click on the files to open a diff view within the web IDE. Take a look at these files and verify that the PR adds a new endpoint, as well as a unit test. -Clicking on the "Description" menu item opens a new webview displaying the PR in a similar UI as to what we would see on GitHub. -Checkout the branch by clicking "Checkout" at the top right on Figure 6. +Click on the "Description" menu item to open a new webview displaying the PR in a UI similar to GitHub. Check out the branch by clicking "Checkout" at the top right of Figure 6. -image::/assets/img/reviewing-pull-requests/pr-view.png[Viewing the PR within the IDE] -Figure 6: A webview that displays details about the PR. This webview appears after clicking the "Description" menu item from Figure 5. +image::/assets/img/reviewing-pull-requests/pr-view.png[Viewing the PR within the web IDE] +Figure 6: A webview displaying details about the PR. This webview appears after clicking the "Description" menu item from Figure 5. -Since the link:https://github.com/redhat-developer/vscode-java[Language support for Java ™] plugin is already installed in our IDE (as defined for our project),once the plugin is running we can verify right away that it reports no compilation errors like syntax errors by referring to the Problems view. +The test project comes with a preinstalled link:https://github.com/redhat-developer/vscode-java[Language support for Java ™] extension in the web IDE. With this extension, you can check the Problem view to verify that there are no compilation problems such as syntax errors. -image::/assets/img/reviewing-pull-requests/no-problems.png[No problems reported by the Java plugin] -Figure 7: No problems reported by the Java plugin in the Problems view. +image::/assets/img/reviewing-pull-requests/no-problems.png[No problems reported by the Java extension] +Figure 7: No problems reported by the Java extension in the Problems view. === Running unit tests and building -The devfile also defines commands for testing, building, and launching the application. -Let's run the unit tests by opening the Workspace view from the right-hand side and clicking `(User Runtimes -> tools -> runtests)`. +The devfile also defines commands for testing, building, and launching the application. Run the unit tests by opening the Workspace view from the right-hand side and clicking `(User Runtimes -> tools -> runtests)`. -This runs the test command (`./mvnw test`) within the `tools` container as specified in the devfile. The test output can be viewed in the output panel. +This runs the test command (`./mvnw test`) within the `tools` container as specified in the devfile. You can view the test output in the output panel. image::/assets/img/reviewing-pull-requests/run-tests.png[Running the unit tests] Figure 8: Unit testing by clicking `runtests` from the Workspace view on the right. -As we can see in the output from Figure 8, all of the tests pass! +As you can see in the output from Figure 8, you passed the tests successfully. You can also run other commands such as `(User Runtimes -> tools -> package)` to build the application. image::/assets/img/reviewing-pull-requests/build.png[Successfully building the application] Figure 9: Successfully building the application. -NOTE: Please note, the `packagenative` command is used to build a native image with GraalVM. This command would fail for our example project on link:https://www.eclipse.org/che/docs/che-7/hosted-che/hosted-che/[Eclipse Che Hosted by Red Hat] due to the 7GB memory usage limit. +NOTE: The `packagenative` command is used to build a native image with GraalVM. The command would fail for this test project on link:https://www.eclipse.org/che/docs/che-7/hosted-che/hosted-che/[Eclipse Che Hosted by Red Hat] due to the 7GB memory usage limit. === Running the application -Let's run the Quarkus application in link:https://quarkus.io/guides/getting-started#development-mode[development mode] by running the `(User Runtimes -> tools -> startdev)` command to try accessing the endpoint ourselves. +Run the Quarkus application in link:https://quarkus.io/guides/getting-started#development-mode[development mode] by running the `(User Runtimes -> tools -> startdev)` command to access the endpoint. image::/assets/img/reviewing-pull-requests/start-dev.png[Starting the application in development mode] Figure 10: Starting the Quarkus project in development mode by clicking `startdev` from the Workspace view on the right. -Next, let's access the new `/food/restaurant/{restaurantName}` endpoint. Here, we access `/food/restaurant/Local Deli` to get all `Food` resources from the restaurant named `Local Deli`. +Next, access the new `/food/restaurant/{restaurantName}` endpoint. Here, you access `/food/restaurant/Local Deli` to get all `Food` resources from the restaurant named `Local Deli`. image::/assets/img/reviewing-pull-requests/access-endpoint.png[Accessing the new endpoint] Figure 11: Response from `/food/restaurant/Local Deli`. -There are two `Food` resources from the `Local Deli` restaurant from the response, which is what we would expect given that these are the only `Food` resources from the specified restaurant in our link:https://github.com/che-incubator/quarkus-api-example/blob/main/src/main/resources/import.sql[`import.sql`] file. +The response contains two `Food`` resources from the `Local Deli`` restaurant. This is a match with the `Food` resources from the this restaurant in the link:https://github.com/che-incubator/quarkus-api-example/blob/main/src/main/resources/import.sql[`import.sql`] file. === Providing feedback and merging the PR -So far, we have successfully run tests, ran the build, as well as ran the application in development mode to verify that the PR is working correctly. -Next, let's merge the PR from the IDE. +So far, you have successfully run tests, ran the build, as well as ran the application in development mode to verify that the PR is working correctly. +Next, merge the PR from the web IDE. -Going back to the GitHub PR view (see Figure 5), we can provide any additional comments, and approve the PR. Let's merge this PR to `main`. +Go back to the GitHub PR view (see Figure 5) to provide more comments, and approve the PR. Merge the PR to `main`. -image::/assets/img/reviewing-pull-requests/merge.png[Merging to main from the IDE] +image::/assets/img/reviewing-pull-requests/merge.png[Merging to main from the web IDE] Figure 12: Clicking "Merge Pull Request" to merge. -image::/assets/img/reviewing-pull-requests/merged.png[Merged to main from the IDE] +image::/assets/img/reviewing-pull-requests/merged.png[Merged to main from the web IDE] Figure 13: PR has been merged. === Conclusion -And that's it! We have finished reviewing the PR and have successfully merged it from the IDE editor. +You have finished reviewing the PR and have successfully merged it from the web IDE editor. In summary, we have: * Opened a new {prod} workspace to review the PR @@ -171,9 +166,9 @@ In summary, we have: * Ran the unit tests * Built the application * Ran the application in development mode to verify that the feature works as intended -* Leveraged the GitHub Pull Requests and Issues plugin and the Language support for Java ™ plugin -* Merged the PR from the IDE +* Used the GitHub Pull Requests and Issues extension and the Language support for Java ™ extension +* Merged the PR from the web IDE -without any prior setup on our local machine. +without any prior setup on your local machine. Thank you for reading! \ No newline at end of file From c2d79e90d117c3932c40bc8c0989bfaff35f834e Mon Sep 17 00:00:00 2001 From: Jana Vrbkova <80100533+deerskindoll@users.noreply.github.com> Date: Wed, 16 Feb 2022 10:54:29 +0100 Subject: [PATCH 02/18] Update _posts/2022-02-16-reviewing-pull-requests.adoc Co-authored-by: Ilya Buziuk --- _posts/2022-02-16-reviewing-pull-requests.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_posts/2022-02-16-reviewing-pull-requests.adoc b/_posts/2022-02-16-reviewing-pull-requests.adoc index 40db7c38..298cad4a 100644 --- a/_posts/2022-02-16-reviewing-pull-requests.adoc +++ b/_posts/2022-02-16-reviewing-pull-requests.adoc @@ -13,7 +13,7 @@ Reviewing pull requests for a GitHub project integrated with {prod}. === Using {prod} to review pull requests -With Google Chrome, Eclipse Che makes it possible to review a pull request (PR) without setting up runtimes, build tools, or any extra software on the local machine. +With Google Chrome, {prod} makes it possible to review a pull request (PR) without setting up runtimes, build tools, or any extra software on the local machine. This blog post will showcase the typical workflow of reviewing PRs of a GitHub project that is well-integrated with Eclipse Che. Here is the GitHub project used in this blog post: link:https://github.com/che-incubator/quarkus-api-example[www.github.com/che-incubator/quarkus-api-example]. From 14a760769ed99925a4d9f1527a88453d0691fbab Mon Sep 17 00:00:00 2001 From: Jana Vrbkova <80100533+deerskindoll@users.noreply.github.com> Date: Wed, 16 Feb 2022 10:54:42 +0100 Subject: [PATCH 03/18] Update _posts/2022-02-16-reviewing-pull-requests.adoc Co-authored-by: Ilya Buziuk --- _posts/2022-02-16-reviewing-pull-requests.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_posts/2022-02-16-reviewing-pull-requests.adoc b/_posts/2022-02-16-reviewing-pull-requests.adoc index 298cad4a..c3ea729e 100644 --- a/_posts/2022-02-16-reviewing-pull-requests.adoc +++ b/_posts/2022-02-16-reviewing-pull-requests.adoc @@ -69,7 +69,7 @@ In the current state of the project, there are four endpoints: |Creates a Food resource |=== -It looks like your colleague has opened a new PR that adds a new `GET` endpoint, `/food/restaurant/{restaurantName}`. The endpoint retrieves a list of all `Food`` resources served from a specified restaurant: +It looks like your colleague has opened a new PR that adds a new `GET` endpoint, `/food/restaurant/{restaurantName}`. The endpoint retrieves a list of all `Food` resources served from a specified restaurant: image::/assets/img/reviewing-pull-requests/pr.png[The pull request to review] Figure 1: The GitHub PR you need to review. From a66d8e7e340796508ab70ccd3afe91eddcaeff37 Mon Sep 17 00:00:00 2001 From: Jana Vrbkova <80100533+deerskindoll@users.noreply.github.com> Date: Wed, 16 Feb 2022 11:12:10 +0100 Subject: [PATCH 04/18] Update _posts/2022-02-16-reviewing-pull-requests.adoc Co-authored-by: Ilya Buziuk --- _posts/2022-02-16-reviewing-pull-requests.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_posts/2022-02-16-reviewing-pull-requests.adoc b/_posts/2022-02-16-reviewing-pull-requests.adoc index c3ea729e..361cef60 100644 --- a/_posts/2022-02-16-reviewing-pull-requests.adoc +++ b/_posts/2022-02-16-reviewing-pull-requests.adoc @@ -103,7 +103,7 @@ Figure 5: The GitHub view, opened by clicking on the fifth icon from the top. WARNING: If you launch a workspace with a badge generated using the link:https://github.com/marketplace/actions/try-in-web-ide[Try in Web IDE] GitHub action on a PR from a forked repository, you must manually set up git remotes in order to use the GitHub Pull Requests and Issues extension. Please see link:https://github.com/redhat-actions/try-in-web-ide/issues/14[redhat-actions/try-in-web-ide#14]. -The "Description" menu item, as well as a file hierarchy with all changed files, are in the drop-down menu below the PR. In this case, the changed files are FoodResource.java, FoodEndpointTest.java, and README.md. Click on the files to open a diff view within the web IDE. Take a look at these files and verify that the PR adds a new endpoint, as well as a unit test. +The "Description" menu item, as well as a file hierarchy with all changed files, are in the drop-down menu below the PR. In this case, the changed files are `FoodResource.java`, `FoodEndpointTest.java`, and `README.md`. Click on the files to open a diff view within the web IDE. Take a look at these files and verify that the PR adds a new endpoint, as well as a unit test. Click on the "Description" menu item to open a new webview displaying the PR in a UI similar to GitHub. Check out the branch by clicking "Checkout" at the top right of Figure 6. From f0a0ada222d273125cbd53db9cd2393805892ca4 Mon Sep 17 00:00:00 2001 From: Jana Vrbkova <80100533+deerskindoll@users.noreply.github.com> Date: Wed, 16 Feb 2022 11:12:26 +0100 Subject: [PATCH 05/18] Update _posts/2022-02-16-reviewing-pull-requests.adoc Co-authored-by: Ilya Buziuk --- _posts/2022-02-16-reviewing-pull-requests.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_posts/2022-02-16-reviewing-pull-requests.adoc b/_posts/2022-02-16-reviewing-pull-requests.adoc index 361cef60..afe4756f 100644 --- a/_posts/2022-02-16-reviewing-pull-requests.adoc +++ b/_posts/2022-02-16-reviewing-pull-requests.adoc @@ -143,7 +143,7 @@ Next, access the new `/food/restaurant/{restaurantName}` endpoint. Here, you acc image::/assets/img/reviewing-pull-requests/access-endpoint.png[Accessing the new endpoint] Figure 11: Response from `/food/restaurant/Local Deli`. -The response contains two `Food`` resources from the `Local Deli`` restaurant. This is a match with the `Food` resources from the this restaurant in the link:https://github.com/che-incubator/quarkus-api-example/blob/main/src/main/resources/import.sql[`import.sql`] file. +The response contains two `Food` resources from the `Local Deli` restaurant. This is a match with the `Food` resources from this restaurant in the link:https://github.com/che-incubator/quarkus-api-example/blob/main/src/main/resources/import.sql[`import.sql`] file. === Providing feedback and merging the PR So far, you have successfully run tests, ran the build, as well as ran the application in development mode to verify that the PR is working correctly. From 8c2087f86f2d7932a9130f31676dafb76253d680 Mon Sep 17 00:00:00 2001 From: Jana Vrbkova <80100533+deerskindoll@users.noreply.github.com> Date: Wed, 16 Feb 2022 16:15:04 +0100 Subject: [PATCH 06/18] Update _posts/2022-02-16-reviewing-pull-requests.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fabrice Flore-Thébault --- _posts/2022-02-16-reviewing-pull-requests.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_posts/2022-02-16-reviewing-pull-requests.adoc b/_posts/2022-02-16-reviewing-pull-requests.adoc index afe4756f..cef33043 100644 --- a/_posts/2022-02-16-reviewing-pull-requests.adoc +++ b/_posts/2022-02-16-reviewing-pull-requests.adoc @@ -22,7 +22,7 @@ You can refer to these articles on how to set up your project with {prod}: * <<../../01/11/@ilya.buziuk-contributing-for-the-first-time-to-a-project#set-up-project,How can maintainers set up their projects to use Eclipse Che?>> * link:https://www.eclipse.org/che/docs/che-7/end-user-guide/authoring-devfiles-version-2[Authoring a devfile v2] -NOTE: Your project must contain a well-defined devfile.yaml file to make the most out of your development experience with {prod}. Use the devfile to define your project’s development environment such as development commands, containers, endpoints, etc. +NOTE: Your project must contain a well-defined `devfile.yaml` file to make the most out of your development experience with {prod}. Use the devfile to define your project’s development environment such as development commands, containers, endpoints, and so on. WARNING: The following scenario uses devfile v2, and {prod} is deployed alongside the {devworkspace} engine currently not used on link:https://workspaces.openshift.com/[Eclipse Che Hosted by Red Hat]. To open the test GitHub project on Eclipse Che Hosted by Red Hat, please use the link:https://github.com/che-incubator/quarkus-api-example/tree/devfilev1[devfilev1] branch supports the deprecated devfile v1. From a0d777cbbe2bfbbb0315b91886469c6af18837c0 Mon Sep 17 00:00:00 2001 From: Jana Vrbkova <80100533+deerskindoll@users.noreply.github.com> Date: Wed, 16 Feb 2022 16:15:29 +0100 Subject: [PATCH 07/18] Update _posts/2022-02-16-reviewing-pull-requests.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fabrice Flore-Thébault --- _posts/2022-02-16-reviewing-pull-requests.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_posts/2022-02-16-reviewing-pull-requests.adoc b/_posts/2022-02-16-reviewing-pull-requests.adoc index cef33043..3283e4b9 100644 --- a/_posts/2022-02-16-reviewing-pull-requests.adoc +++ b/_posts/2022-02-16-reviewing-pull-requests.adoc @@ -76,7 +76,7 @@ Figure 1: The GitHub PR you need to review. Review this PR by launching a new {prod} workspace. Here you can verify the PR by running unit tests, running the application, accessing the endpoint, and building the application, all within your web browser. -Launch the workspace and Web IDE editor on link:https://www.eclipse.org/che/docs/che-7/hosted-che/hosted-che/[Eclipse Che Hosted by Red Hat] by clicking the {prod} badge from the base GitHub repository's `README`: +Start the workspace and Web IDE editor on link:https://www.eclipse.org/che/docs/che-7/hosted-che/hosted-che/[Eclipse Che Hosted by Red Hat] by clicking the {prod} badge from the base GitHub repository's `README`: image::/assets/img/reviewing-pull-requests/badge.png[Badge used to launch workspaces] Figure 2: Clicking on a badge from the base repository's `README.md` launches a developer workspace. From 09d37b7e66c5f010827bf4ff09d4039683005b96 Mon Sep 17 00:00:00 2001 From: Jana Vrbkova <80100533+deerskindoll@users.noreply.github.com> Date: Wed, 16 Feb 2022 16:15:40 +0100 Subject: [PATCH 08/18] Update _posts/2022-02-16-reviewing-pull-requests.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fabrice Flore-Thébault --- _posts/2022-02-16-reviewing-pull-requests.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_posts/2022-02-16-reviewing-pull-requests.adoc b/_posts/2022-02-16-reviewing-pull-requests.adoc index 3283e4b9..cb7b7c35 100644 --- a/_posts/2022-02-16-reviewing-pull-requests.adoc +++ b/_posts/2022-02-16-reviewing-pull-requests.adoc @@ -78,7 +78,7 @@ Review this PR by launching a new {prod} workspace. Here you can verify the PR b Start the workspace and Web IDE editor on link:https://www.eclipse.org/che/docs/che-7/hosted-che/hosted-che/[Eclipse Che Hosted by Red Hat] by clicking the {prod} badge from the base GitHub repository's `README`: -image::/assets/img/reviewing-pull-requests/badge.png[Badge used to launch workspaces] +image::/assets/img/reviewing-pull-requests/badge.png[Badge used to start workspaces] Figure 2: Clicking on a badge from the base repository's `README.md` launches a developer workspace. === Launching a workspace and reviewing the PR From 5be850af4c4ebafa4a3ef8291184347d040ddbf7 Mon Sep 17 00:00:00 2001 From: Jana Vrbkova <80100533+deerskindoll@users.noreply.github.com> Date: Wed, 16 Feb 2022 16:16:13 +0100 Subject: [PATCH 09/18] Update _posts/2022-02-16-reviewing-pull-requests.adoc Co-authored-by: David Kwon <83611742+dkwon17@users.noreply.github.com> --- _posts/2022-02-16-reviewing-pull-requests.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_posts/2022-02-16-reviewing-pull-requests.adoc b/_posts/2022-02-16-reviewing-pull-requests.adoc index cb7b7c35..e1851186 100644 --- a/_posts/2022-02-16-reviewing-pull-requests.adoc +++ b/_posts/2022-02-16-reviewing-pull-requests.adoc @@ -24,7 +24,7 @@ You can refer to these articles on how to set up your project with {prod}: NOTE: Your project must contain a well-defined `devfile.yaml` file to make the most out of your development experience with {prod}. Use the devfile to define your project’s development environment such as development commands, containers, endpoints, and so on. -WARNING: The following scenario uses devfile v2, and {prod} is deployed alongside the {devworkspace} engine currently not used on link:https://workspaces.openshift.com/[Eclipse Che Hosted by Red Hat]. To open the test GitHub project on Eclipse Che Hosted by Red Hat, please use the link:https://github.com/che-incubator/quarkus-api-example/tree/devfilev1[devfilev1] branch supports the deprecated devfile v1. +WARNING: The following scenario uses devfile v2, and {prod} is deployed alongside the {devworkspace} engine which is currently not used on link:https://workspaces.openshift.com/[Eclipse Che Hosted by Red Hat]. To open the test GitHub project on Eclipse Che Hosted by Red Hat, please use the link:https://github.com/che-incubator/quarkus-api-example/tree/devfilev1[devfilev1] branch which supports the deprecated devfile v1. === The scenario From 6f220f0f468a190f74df9a10ea81fa6200c032a0 Mon Sep 17 00:00:00 2001 From: Jana Vrbkova <80100533+deerskindoll@users.noreply.github.com> Date: Wed, 16 Feb 2022 16:17:13 +0100 Subject: [PATCH 10/18] Update _posts/2022-02-16-reviewing-pull-requests.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fabrice Flore-Thébault --- _posts/2022-02-16-reviewing-pull-requests.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_posts/2022-02-16-reviewing-pull-requests.adoc b/_posts/2022-02-16-reviewing-pull-requests.adoc index e1851186..b14e76d2 100644 --- a/_posts/2022-02-16-reviewing-pull-requests.adoc +++ b/_posts/2022-02-16-reviewing-pull-requests.adoc @@ -85,7 +85,7 @@ Figure 2: Clicking on a badge from the base repository's `README.md` launches a image::/assets/img/reviewing-pull-requests/ide.png[The Che-theia editor] Figure 3: The Che-Theia editor. -After you launch the workspace, the web IDE will open automatically and you'll see that the project has been cloned already (see the Explorer view on the bottom-right). +After you start the workspace, the web IDE will open automatically and you'll see that the project has been cloned already (see the Explorer view on the lower-right). To use the link:https://github.com/Microsoft/vscode-pull-request-github[GitHub Pull Requests and Issues] extension, you must first authenticate with GitHub by clicking on the Accounts icon on the bottom left of the editor. The extension adds the GitHub view to the sidebar and provides integration with GitHub. As a result, you can make PR comments, in-editor comments, approve PRs, and much more, all from the web IDE. From d70d467e2eaf3b3ee4d697d2eff9216355867cb7 Mon Sep 17 00:00:00 2001 From: Jana Vrbkova <80100533+deerskindoll@users.noreply.github.com> Date: Wed, 16 Feb 2022 16:17:55 +0100 Subject: [PATCH 11/18] Update _posts/2022-02-16-reviewing-pull-requests.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fabrice Flore-Thébault --- _posts/2022-02-16-reviewing-pull-requests.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_posts/2022-02-16-reviewing-pull-requests.adoc b/_posts/2022-02-16-reviewing-pull-requests.adoc index b14e76d2..17683fe0 100644 --- a/_posts/2022-02-16-reviewing-pull-requests.adoc +++ b/_posts/2022-02-16-reviewing-pull-requests.adoc @@ -94,7 +94,7 @@ Click on "Sign in to user GitHub Pull Requests and Issues (1)". You will be prompted to enter your GitHub credentials to sign in. image::/assets/img/reviewing-pull-requests/sign-in.png[The context menu appears after clicking the Accounts icon, 600] -Figure 4: The context menu appears after clicking the Accounts icon. +Figure 4: The menu appears after clicking the Accounts icon. After signing in, navigate to the GitHub view from the sidebar to see an overview of PRs against the base repository. Under the "Assigned To Me" drop-down, you can see the PR that you'll review. From 1952a020155f69f020a027d0b97a1d34cd65eb29 Mon Sep 17 00:00:00 2001 From: Jana Vrbkova <80100533+deerskindoll@users.noreply.github.com> Date: Wed, 16 Feb 2022 16:18:55 +0100 Subject: [PATCH 12/18] Update _posts/2022-02-16-reviewing-pull-requests.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fabrice Flore-Thébault --- _posts/2022-02-16-reviewing-pull-requests.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_posts/2022-02-16-reviewing-pull-requests.adoc b/_posts/2022-02-16-reviewing-pull-requests.adoc index 17683fe0..11b4bbb3 100644 --- a/_posts/2022-02-16-reviewing-pull-requests.adoc +++ b/_posts/2022-02-16-reviewing-pull-requests.adoc @@ -101,7 +101,7 @@ After signing in, navigate to the GitHub view from the sidebar to see an overvie image::/assets/img/reviewing-pull-requests/github-view.png[Viewing the PR within the web IDE, 400] Figure 5: The GitHub view, opened by clicking on the fifth icon from the top. -WARNING: If you launch a workspace with a badge generated using the link:https://github.com/marketplace/actions/try-in-web-ide[Try in Web IDE] GitHub action on a PR from a forked repository, you must manually set up git remotes in order to use the GitHub Pull Requests and Issues extension. Please see link:https://github.com/redhat-actions/try-in-web-ide/issues/14[redhat-actions/try-in-web-ide#14]. +WARNING: If you start a workspace with a badge generated using the link:https://github.com/marketplace/actions/try-in-web-ide[Try in Web IDE] GitHub action on a PR from a forked repository, you must manually set up Git remotes to use the GitHub Pull Requests and Issues extension. Please see link:https://github.com/redhat-actions/try-in-web-ide/issues/14[redhat-actions/try-in-web-ide#14]. The "Description" menu item, as well as a file hierarchy with all changed files, are in the drop-down menu below the PR. In this case, the changed files are `FoodResource.java`, `FoodEndpointTest.java`, and `README.md`. Click on the files to open a diff view within the web IDE. Take a look at these files and verify that the PR adds a new endpoint, as well as a unit test. From de54e5ec407db3e25b37b6c70c02babe73146608 Mon Sep 17 00:00:00 2001 From: Jana Vrbkova <80100533+deerskindoll@users.noreply.github.com> Date: Wed, 16 Feb 2022 16:19:11 +0100 Subject: [PATCH 13/18] Update _posts/2022-02-16-reviewing-pull-requests.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fabrice Flore-Thébault --- _posts/2022-02-16-reviewing-pull-requests.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_posts/2022-02-16-reviewing-pull-requests.adoc b/_posts/2022-02-16-reviewing-pull-requests.adoc index 11b4bbb3..0a2f0cb7 100644 --- a/_posts/2022-02-16-reviewing-pull-requests.adoc +++ b/_posts/2022-02-16-reviewing-pull-requests.adoc @@ -103,7 +103,7 @@ Figure 5: The GitHub view, opened by clicking on the fifth icon from the top. WARNING: If you start a workspace with a badge generated using the link:https://github.com/marketplace/actions/try-in-web-ide[Try in Web IDE] GitHub action on a PR from a forked repository, you must manually set up Git remotes to use the GitHub Pull Requests and Issues extension. Please see link:https://github.com/redhat-actions/try-in-web-ide/issues/14[redhat-actions/try-in-web-ide#14]. -The "Description" menu item, as well as a file hierarchy with all changed files, are in the drop-down menu below the PR. In this case, the changed files are `FoodResource.java`, `FoodEndpointTest.java`, and `README.md`. Click on the files to open a diff view within the web IDE. Take a look at these files and verify that the PR adds a new endpoint, as well as a unit test. +The "Description" menu item, as well as a file hierarchy with all changed files, are in the drop-down menu below the PR. In this case, the changed files are `FoodResource.java`, `FoodEndpointTest.java`, and `README.md`. Click on the files to open a diff view within the web IDE. Examine these files and verify that the PR adds a new endpoint, as well as a unit test. Click on the "Description" menu item to open a new webview displaying the PR in a UI similar to GitHub. Check out the branch by clicking "Checkout" at the top right of Figure 6. From 27f96a728ac34f0c7944ec89609eade6b780feea Mon Sep 17 00:00:00 2001 From: Jana Vrbkova <80100533+deerskindoll@users.noreply.github.com> Date: Wed, 16 Feb 2022 16:19:27 +0100 Subject: [PATCH 14/18] Update _posts/2022-02-16-reviewing-pull-requests.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fabrice Flore-Thébault --- _posts/2022-02-16-reviewing-pull-requests.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_posts/2022-02-16-reviewing-pull-requests.adoc b/_posts/2022-02-16-reviewing-pull-requests.adoc index 0a2f0cb7..537a1737 100644 --- a/_posts/2022-02-16-reviewing-pull-requests.adoc +++ b/_posts/2022-02-16-reviewing-pull-requests.adoc @@ -105,7 +105,7 @@ WARNING: If you start a workspace with a badge generated using the link:https:// The "Description" menu item, as well as a file hierarchy with all changed files, are in the drop-down menu below the PR. In this case, the changed files are `FoodResource.java`, `FoodEndpointTest.java`, and `README.md`. Click on the files to open a diff view within the web IDE. Examine these files and verify that the PR adds a new endpoint, as well as a unit test. -Click on the "Description" menu item to open a new webview displaying the PR in a UI similar to GitHub. Check out the branch by clicking "Checkout" at the top right of Figure 6. +Click on the "Description" menu item to open a new web view displaying the PR in a UI similar to GitHub. Check out the branch by clicking "Checkout" at the top right of Figure 6. image::/assets/img/reviewing-pull-requests/pr-view.png[Viewing the PR within the web IDE] Figure 6: A webview displaying details about the PR. This webview appears after clicking the "Description" menu item from Figure 5. From 83be8bc91daf5827a36f7d6758ab9c3712e115f8 Mon Sep 17 00:00:00 2001 From: Jana Vrbkova <80100533+deerskindoll@users.noreply.github.com> Date: Wed, 16 Feb 2022 16:22:04 +0100 Subject: [PATCH 15/18] Update _posts/2022-02-16-reviewing-pull-requests.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fabrice Flore-Thébault --- _posts/2022-02-16-reviewing-pull-requests.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_posts/2022-02-16-reviewing-pull-requests.adoc b/_posts/2022-02-16-reviewing-pull-requests.adoc index 537a1737..88180a24 100644 --- a/_posts/2022-02-16-reviewing-pull-requests.adoc +++ b/_posts/2022-02-16-reviewing-pull-requests.adoc @@ -108,7 +108,7 @@ The "Description" menu item, as well as a file hierarchy with all changed files, Click on the "Description" menu item to open a new web view displaying the PR in a UI similar to GitHub. Check out the branch by clicking "Checkout" at the top right of Figure 6. image::/assets/img/reviewing-pull-requests/pr-view.png[Viewing the PR within the web IDE] -Figure 6: A webview displaying details about the PR. This webview appears after clicking the "Description" menu item from Figure 5. +Figure 6: A webview displaying details about the PR. This web view appears after clicking the "Description" menu item from Figure 5. The test project comes with a preinstalled link:https://github.com/redhat-developer/vscode-java[Language support for Java ™] extension in the web IDE. With this extension, you can check the Problem view to verify that there are no compilation problems such as syntax errors. From c75941a96b8ce981fa6d8124ad10bba9b73402d6 Mon Sep 17 00:00:00 2001 From: Jana Vrbkova <80100533+deerskindoll@users.noreply.github.com> Date: Wed, 16 Feb 2022 16:22:14 +0100 Subject: [PATCH 16/18] Update _posts/2022-02-16-reviewing-pull-requests.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fabrice Flore-Thébault --- _posts/2022-02-16-reviewing-pull-requests.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_posts/2022-02-16-reviewing-pull-requests.adoc b/_posts/2022-02-16-reviewing-pull-requests.adoc index 88180a24..c3657ace 100644 --- a/_posts/2022-02-16-reviewing-pull-requests.adoc +++ b/_posts/2022-02-16-reviewing-pull-requests.adoc @@ -110,7 +110,7 @@ Click on the "Description" menu item to open a new web view displaying the PR in image::/assets/img/reviewing-pull-requests/pr-view.png[Viewing the PR within the web IDE] Figure 6: A webview displaying details about the PR. This web view appears after clicking the "Description" menu item from Figure 5. -The test project comes with a preinstalled link:https://github.com/redhat-developer/vscode-java[Language support for Java ™] extension in the web IDE. With this extension, you can check the Problem view to verify that there are no compilation problems such as syntax errors. +The test project includes a preinstalled link:https://github.com/redhat-developer/vscode-java[Language support for Java ™] extension in the web IDE. With this extension, you can check the Problem view to verify that there are no compilation problems such as syntax errors. image::/assets/img/reviewing-pull-requests/no-problems.png[No problems reported by the Java extension] Figure 7: No problems reported by the Java extension in the Problems view. From 167a85dfbe00d823236c50f7360c97c16c840427 Mon Sep 17 00:00:00 2001 From: Jana Vrbkova <80100533+deerskindoll@users.noreply.github.com> Date: Wed, 16 Feb 2022 16:22:25 +0100 Subject: [PATCH 17/18] Update _posts/2022-02-16-reviewing-pull-requests.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fabrice Flore-Thébault --- _posts/2022-02-16-reviewing-pull-requests.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_posts/2022-02-16-reviewing-pull-requests.adoc b/_posts/2022-02-16-reviewing-pull-requests.adoc index c3657ace..cd6e30ba 100644 --- a/_posts/2022-02-16-reviewing-pull-requests.adoc +++ b/_posts/2022-02-16-reviewing-pull-requests.adoc @@ -116,7 +116,7 @@ image::/assets/img/reviewing-pull-requests/no-problems.png[No problems reported Figure 7: No problems reported by the Java extension in the Problems view. === Running unit tests and building -The devfile also defines commands for testing, building, and launching the application. Run the unit tests by opening the Workspace view from the right-hand side and clicking `(User Runtimes -> tools -> runtests)`. +The devfile also defines commands for testing, building, and launching the application. Run the unit tests by opening the Workspace view from the right side and clicking `(User Runtimes -> tools -> runtests)`. This runs the test command (`./mvnw test`) within the `tools` container as specified in the devfile. You can view the test output in the output panel. From 6e3ff0459a729b60962c79e1d20ddb206d929d37 Mon Sep 17 00:00:00 2001 From: Jana Vrbkova <80100533+deerskindoll@users.noreply.github.com> Date: Wed, 16 Feb 2022 16:26:06 +0100 Subject: [PATCH 18/18] Update 2022-02-16-reviewing-pull-requests.adoc quick typo fix --- _posts/2022-02-16-reviewing-pull-requests.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_posts/2022-02-16-reviewing-pull-requests.adoc b/_posts/2022-02-16-reviewing-pull-requests.adoc index cd6e30ba..788d7e02 100644 --- a/_posts/2022-02-16-reviewing-pull-requests.adoc +++ b/_posts/2022-02-16-reviewing-pull-requests.adoc @@ -85,7 +85,7 @@ Figure 2: Clicking on a badge from the base repository's `README.md` launches a image::/assets/img/reviewing-pull-requests/ide.png[The Che-theia editor] Figure 3: The Che-Theia editor. -After you start the workspace, the web IDE will open automatically and you'll see that the project has been cloned already (see the Explorer view on the lower-right). +After you start the workspace, the web IDE will open automatically and you'll see that the project has been cloned already (see the Explorer view on the left-hand side). To use the link:https://github.com/Microsoft/vscode-pull-request-github[GitHub Pull Requests and Issues] extension, you must first authenticate with GitHub by clicking on the Accounts icon on the bottom left of the editor. The extension adds the GitHub view to the sidebar and provides integration with GitHub. As a result, you can make PR comments, in-editor comments, approve PRs, and much more, all from the web IDE. @@ -171,4 +171,4 @@ In summary, we have: without any prior setup on your local machine. -Thank you for reading! \ No newline at end of file +Thank you for reading!