This is an automated email from the ASF dual-hosted git repository.
rzo1 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/storm-site.git
The following commit(s) were added to refs/heads/main by this push:
new 1f53d78137 Update README and add staging action
1f53d78137 is described below
commit 1f53d78137cfef2d3ca0ad5b18e8c143cdde5a40
Author: Richard Zowalla <[email protected]>
AuthorDate: Fri May 2 20:34:51 2025 +0200
Update README and add staging action
---
.github/workflows/publish-staging.yml | 61 +++++++++++++++++++++++++++++++++++
README.md | 9 ++----
2 files changed, 63 insertions(+), 7 deletions(-)
diff --git a/.github/workflows/publish-staging.yml
b/.github/workflows/publish-staging.yml
new file mode 100644
index 0000000000..754e702109
--- /dev/null
+++ b/.github/workflows/publish-staging.yml
@@ -0,0 +1,61 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+name: Publish staging website
+
+on:
+ # Allows you to run this workflow manually from the Actions tab
+ workflow_dispatch:
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v3
+ - name: Setup Ruby
+ uses: ruby/[email protected]
+ with:
+ ruby-version: '3.1' # Not needed with a .ruby-version file
+ bundler-cache: true # runs 'bundle install' and caches installed
gems automatically
+ cache-version: 0 # Increment this number if you need to re-download
cached gems
+ - name: Build with Jekyll
+ # Outputs to the './_site' directory by default
+ run: bundle exec jekyll build
+ env:
+ JEKYLL_ENV: production
+ - name: 'Checkout asf-staging'
+ uses: actions/checkout@v4
+ with:
+ repository: 'apache/incubator-stormcrawler-site'
+ ref: 'asf-staging'
+ path: 'asf-staging'
+
+ - name: 'Copy build to site repo'
+ run: |
+ rsync -avP --delete --exclude .git --exclude README.md --exclude
.asf.yaml _site/. ./asf-staging
+ shell: bash
+
+ - name: 'commit site'
+ working-directory: ./asf-staging
+ run: |
+ git config user.name "GitHub Actions Bot"
+ git config user.email "<>"
+ git add .
+ git commit -m "publishing $(date -Is)"
+ git push
+ shell: bash
\ No newline at end of file
diff --git a/README.md b/README.md
index 784f1338b3..d3dbcc9898 100644
--- a/README.md
+++ b/README.md
@@ -61,14 +61,9 @@ Compose a new blog post announcement for the new release on
the `_posts` folder.
Update the downloads page on `downloads.html` to point to the new version's
links.
+## Build with GitHub actions
-To publish the site, run the following from the storm-site root
-```
-bundle exec jekyll build -d content
-git add content
-git commit
-```
-and push the commit to the asf-site branch.
+The website is automatically build on a push to main and any changes are
pushed to the asf-site branch. A preview is available via
https://storm.staged.apache.org/ if you go to the GitHub Actions tab and
trigger a manual staging deploy action.
## How release specific docs work
