This is an automated email from the ASF dual-hosted git repository.
yamamuro pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/spark-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 0b3a4e6 Add descriptions about GitHub Actions in the "Useful
Developer Tools" page
0b3a4e6 is described below
commit 0b3a4e606efbd97d6c53407fb60c62a0518c157f
Author: Takeshi Yamamuro <[email protected]>
AuthorDate: Sun Aug 23 20:31:13 2020 +0900
Add descriptions about GitHub Actions in the "Useful Developer Tools" page
This PR adds descriptions about how to run tests in a forked repository
using GitHub Actions.
This comes from https://github.com/apache/spark/pull/29504.
<img width="700" alt="Screen Shot 2020-08-22 at 23 03 19"
src="https://user-images.githubusercontent.com/692303/90958036-6c520f80-e4cc-11ea-8bc4-f1602bd45bf4.png";>
Author: Takeshi Yamamuro <[email protected]>
Closes #286 from maropu/github-actions.
---
developer-tools.md | 19 +++++++++++++++++++
images/running-tests-using-github-actions.png | Bin 0 -> 312696 bytes
site/developer-tools.html | 21 +++++++++++++++++++++
site/images/running-tests-using-github-actions.png | Bin 0 -> 312696 bytes
4 files changed, 40 insertions(+)
diff --git a/developer-tools.md b/developer-tools.md
index c664dfc..0078538 100644
--- a/developer-tools.md
+++ b/developer-tools.md
@@ -228,6 +228,25 @@ Getting logs from the pods and containers directly is an
exercise left to the re
Kubernetes, and more importantly, minikube have rapid release cycles, and
point releases have been found to be buggy and/or break older and existing
functionality. If you are having trouble getting tests to pass on Jenkins, but
locally things work, don't hesitate to file a Jira issue.
+<h3>Running tests in your forked repository using GitHub Actions</h3>
+
+GitHub Actions is a functionality within GitHub that enables continuous
integration and a wide range of automation.
+We already have started using some action scripts and one of them is to run
tests for [pull requests](https://spark.apache.org/contributing.html).
+If you are planning to create a new pull request, it is important to check if
tests can pass on your branch before creating a pull request.
+This is because our GitHub Acrions script automatically runs tests for your
pull request/following commits and
+this can burden our limited resources of GitHub Actions.
+
+Our script enables you to run tests for a branch in your forked repository.
+Let's say that you have a branch named "your_branch" for a pull request.
+To run tests on "your_branch" and check test results:
+
+- Clicks a "Actions" tab in your forked repository.
+- Selects a "Build and test" workflow in a "All workflows" list.
+- Pushes a "Run workflow" button and enters "your_branch" in a "Target branch
to run" field.
+- When a "Build and test" workflow finished, clicks a "Report test results"
workflow to check test results.
+
+<img src="/images/running-tests-using-github-actions.png" style="width: 100%;
max-width: 800px;" />
+
<h3>ScalaTest Issues</h3>
If the following error occurs when running ScalaTest
diff --git a/images/running-tests-using-github-actions.png
b/images/running-tests-using-github-actions.png
new file mode 100644
index 0000000..819203e
Binary files /dev/null and b/images/running-tests-using-github-actions.png
differ
diff --git a/site/developer-tools.html b/site/developer-tools.html
index ff34db0..f064c0a 100644
--- a/site/developer-tools.html
+++ b/site/developer-tools.html
@@ -406,6 +406,27 @@ minikube stop
<p>Kubernetes, and more importantly, minikube have rapid release cycles, and
point releases have been found to be buggy and/or break older and existing
functionality. If you are having trouble getting tests to pass on Jenkins, but
locally things work, don’t hesitate to file a Jira issue.</p>
+<h3>Running tests in your forked repository using GitHub Actions</h3>
+
+<p>GitHub Actions is a functionality within GitHub that enables continuous
integration and a wide range of automation.
+We already have started using some action scripts and one of them is to run
tests for <a href="https://spark.apache.org/contributing.html";>pull
requests</a>.
+If you are planning to create a new pull request, it is important to check if
tests can pass on your branch before creating a pull request.
+This is because our GitHub Acrions script automatically runs tests for your
pull request/following commits and
+this can burden our limited resources of GitHub Actions.</p>
+
+<p>Our script enables you to run tests for a branch in your forked repository.
+Let’s say that you have a branch named “your_branch” for a
pull request.
+To run tests on “your_branch” and check test results:</p>
+
+<ul>
+ <li>Clicks a “Actions” tab in your forked repository.</li>
+ <li>Selects a “Build and test” workflow in a “All
workflows” list.</li>
+ <li>Pushes a “Run workflow” button and enters
“your_branch” in a “Target branch to run” field.</li>
+ <li>When a “Build and test” workflow finished, clicks a
“Report test results” workflow to check test results.</li>
+</ul>
+
+<p><img src="/images/running-tests-using-github-actions.png" style="width:
100%; max-width: 800px;" /></p>
+
<h3>ScalaTest Issues</h3>
<p>If the following error occurs when running ScalaTest</p>
diff --git a/site/images/running-tests-using-github-actions.png
b/site/images/running-tests-using-github-actions.png
new file mode 100644
index 0000000..819203e
Binary files /dev/null and b/site/images/running-tests-using-github-actions.png
differ
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
![https://user-images.githubusercontent.com/692303/90958036-6c520f80-e4cc-11ea-8bc4-f1602bd45bf4.png"](https://user-images.githubusercontent.com/692303/90958036-6c520f80-e4cc-11ea-8bc4-f1602bd45bf4.png"){kind=link}