Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions .asf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,10 @@ staging:

publish:
whoami: asf-site

github:
enabled_merge_buttons:
squash: true
squash_commit_message: PR_TITLE_AND_DESC
merge: false
rebase: false
4 changes: 0 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,3 @@ compile phase, use the following syntax:

You probably don't need to install that unless you want to regenerate the Pygments CSS file.
It requires Python, and can be installed by running `sudo easy_install Pygments`.

## Merge PR

To merge pull request, use the `merge_pr.py` script which also squashes the commits.
2 changes: 1 addition & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ kramdown:
entity_output: symbol
permalink: none
destination: site
exclude: ['README.md', 'content', 'LICENSE', 'merge_pr.py', 'Gemfile', 'Gemfile.lock']
exclude: ['README.md', 'content', 'LICENSE', 'Gemfile', 'Gemfile.lock']
keep_files: ['docs', 'static', 'llms.txt']
url: https://spark.apache.org
24 changes: 2 additions & 22 deletions committers.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,29 +245,9 @@ Once a PR is merged please leave a comment on the PR stating which branch(es) it

<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.
Pull requests to the [Spark website repo](https://github.com/apache/spark-website) are merged separately from the [main Spark repo](https://github.com/apache/spark). Unlike the main repo, the website uses `asf-site` as its default branch; 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.
The website repo does not use a merge script. Instead, use GitHub's "Squash and merge" button to merge PRs.

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

Expand Down
290 changes: 0 additions & 290 deletions merge_pr.py

This file was deleted.

23 changes: 2 additions & 21 deletions site/committers.html
Original file line number Diff line number Diff line change
Expand Up @@ -711,28 +711,9 @@ <h4>Merge script</h4>

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

<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>
<p>The website repo does not use a merge script. Instead, use GitHub&#8217;s &#8220;Squash and merge&#8221; button to merge PRs.</p>

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

Expand Down
Loading