Skip to content

Document how to merge website pull requests on the Committers page #695

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
szehon-ho wants to merge 1 commit into from
+51 −0
Closed

Document how to merge website pull requests on the Committers page #695

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions committers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,32 @@ can do this automatically in most cases.

Once a PR is merged please leave a comment on the PR stating which branch(es) it has been merged with.

<h4>Merging website pull requests</h4>

Pull requests to the Spark website (the
<a href="https://github.com/apache/spark-website">apache/spark-website</a> repository) are merged
separately from the main Spark repo. Unlike `apache/spark`, this repository uses `asf-site` as its
default branch, and there is no `master` branch.

Website PRs are merged using the
<a href="https://github.com/apache/spark-website/blob/asf-site/merge_pr.py">merge_pr.py</a> script
in the root of the `spark-website` repository, which squashes the pull request's changes into one
commit, just like `merge_spark_pr.py` does for the main repo.

To use it, set up remotes in your local clone of `spark-website` the same way as for the main repo:
an `apache` remote (the default `PUSH_REMOTE_NAME`, used for pushing the squashed commit) and an
`apache-github` remote (the default `PR_REMOTE_NAME`, used for pulling the change), both pointing at
`git@github.com:apache/spark-website.git`. Then run the script from the repository root:

```
./merge_pr.py
```

The script is interactive and walks you through selecting the PR and pushing the merge to the
`asf-site` branch. Before merging, make sure the pull request includes the regenerated HTML under
`site/` in addition to the Markdown/HTML source changes; see the repository's `README.md` for how
the site is built.

<h3>Policy on backporting bug fixes</h3>

From <a href="https://www.mail-archive.com/dev@spark.apache.org/msg10284.html">`pwendell`</a>:
Expand Down
25 changes: 25 additions & 0 deletions site/committers.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -708,6 +708,31 @@ <h4>Merge script</h4>

<p>Once a PR is merged please leave a comment on the PR stating which branch(es) it has been merged with.</p>

<h4>Merging website pull requests</h4>

<p>Pull requests to the Spark website (the
<a href="https://github.com/apache/spark-website">apache/spark-website</a> repository) are merged
separately from the main Spark repo. Unlike <code class="language-plaintext highlighter-rouge">apache/spark</code>, this repository uses <code class="language-plaintext highlighter-rouge">asf-site</code> as its
default branch, and there is no <code class="language-plaintext highlighter-rouge">master</code> branch.</p>

<p>Website PRs are merged using the
<a href="https://github.com/apache/spark-website/blob/asf-site/merge_pr.py">merge_pr.py</a> script
in the root of the <code class="language-plaintext highlighter-rouge">spark-website</code> repository, which squashes the pull request&#8217;s changes into one
commit, just like <code class="language-plaintext highlighter-rouge">merge_spark_pr.py</code> does for the main repo.</p>

<p>To use it, set up remotes in your local clone of <code class="language-plaintext highlighter-rouge">spark-website</code> the same way as for the main repo:
an <code class="language-plaintext highlighter-rouge">apache</code> remote (the default <code class="language-plaintext highlighter-rouge">PUSH_REMOTE_NAME</code>, used for pushing the squashed commit) and an
<code class="language-plaintext highlighter-rouge">apache-github</code> remote (the default <code class="language-plaintext highlighter-rouge">PR_REMOTE_NAME</code>, used for pulling the change), both pointing at
<code class="language-plaintext highlighter-rouge">git@github.com:apache/spark-website.git</code>. Then run the script from the repository root:</p>

<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>./merge_pr.py
</code></pre></div></div>

<p>The script is interactive and walks you through selecting the PR and pushing the merge to the
<code class="language-plaintext highlighter-rouge">asf-site</code> branch. Before merging, make sure the pull request includes the regenerated HTML under
<code class="language-plaintext highlighter-rouge">site/</code> in addition to the Markdown/HTML source changes; see the repository&#8217;s <code class="language-plaintext highlighter-rouge">README.md</code> for how
the site is built.</p>

<h3>Policy on backporting bug fixes</h3>

<p>From <a href="https://www.mail-archive.com/dev@spark.apache.org/msg10284.html"><code class="language-plaintext highlighter-rouge">pwendell</code></a>:</p>
Expand Down
Loading