This is an automated email from the ASF dual-hosted git repository.
dahn pushed a commit to branch staging-site
in repository https://gitbox.apache.org/repos/asf/cloudstack-www.git
The following commit(s) were added to refs/heads/staging-site by this push:
new b8819fd63 two step staging procedure (#150)
b8819fd63 is described below
commit b8819fd639229db03d4e7c2b6a97c712d7cdbff8
Author: dahn <[email protected]>
AuthorDate: Thu Feb 8 11:28:42 2024 +0100
two step staging procedure (#150)
+ publishing procedure
---
.github/workflows/deploy.yml | 22 ----------------------
.github/workflows/{deploy.yml => stage.yaml} | 24 +-----------------------
README.md | 17 +++++++++++++++--
3 files changed, 16 insertions(+), 47 deletions(-)
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
index e3167cae5..e9d87eba4 100644
--- a/.github/workflows/deploy.yml
+++ b/.github/workflows/deploy.yml
@@ -39,28 +39,6 @@ jobs:
cp .asf.yaml ./build/.asf.yaml
export WWW_COMMIT=`git rev-parse HEAD`
- - name: Publish PR change to staging site
- uses: peaceiris/actions-gh-pages@v3
- if: github.event_name != 'pull_request'
- with:
- github_token: ${{ secrets.GITHUB_TOKEN }}
- publish_branch: staged-site
- publish_dir: ./build
- destination_dir: ./
- user_name: 'github-actions[bot]'
- user_email: 'github-actions[bot]@users.noreply.github.com'
- commit_message: 'Automated CloudStack
https://cloudstack.staged.apache.org staging website deployment with
cloudstack-www branch ${{ github.event.inputs.branch }}@${{ env.WWW_COMMIT }}'
- #force_orphan: true
-
-# - name: Comment for PR staging website
-# uses:
peter-evans/create-or-update-comment@c9fcb64660bc90ec1cc535646af190c992007c32
-# if: github.event_name == 'pull_request'
-# with:
-# issue-number: ${{ github.event.pull_request.number }}
-# body: |
-# Your latest pull request changes are published to staging website
-# https://cloudstack.staged.apache.org
-
- name: Publish production website
uses: peaceiris/actions-gh-pages@v3
if: github.event_name != 'pull_request'
diff --git a/.github/workflows/deploy.yml b/.github/workflows/stage.yaml
similarity index 65%
copy from .github/workflows/deploy.yml
copy to .github/workflows/stage.yaml
index e3167cae5..799db0134 100644
--- a/.github/workflows/deploy.yml
+++ b/.github/workflows/stage.yaml
@@ -20,7 +20,7 @@ name: Pages
on:
push:
branches:
- - main
+ - staging
pull_request:
jobs:
@@ -51,25 +51,3 @@ jobs:
user_email: 'github-actions[bot]@users.noreply.github.com'
commit_message: 'Automated CloudStack
https://cloudstack.staged.apache.org staging website deployment with
cloudstack-www branch ${{ github.event.inputs.branch }}@${{ env.WWW_COMMIT }}'
#force_orphan: true
-
-# - name: Comment for PR staging website
-# uses:
peter-evans/create-or-update-comment@c9fcb64660bc90ec1cc535646af190c992007c32
-# if: github.event_name == 'pull_request'
-# with:
-# issue-number: ${{ github.event.pull_request.number }}
-# body: |
-# Your latest pull request changes are published to staging website
-# https://cloudstack.staged.apache.org
-
- - name: Publish production website
- uses: peaceiris/actions-gh-pages@v3
- if: github.event_name != 'pull_request'
- with:
- github_token: ${{ secrets.GITHUB_TOKEN }}
- publish_branch: asf-site
- publish_dir: ./build
- destination_dir: ./
- user_name: 'github-actions[bot]'
- user_email: 'github-actions[bot]@users.noreply.github.com'
- commit_message: 'Automated CloudStack website deployment completed
on branch ${{ github.event.inputs.branch }}@${{ env.WWW_COMMIT }}'
- #force_orphan: true
diff --git a/README.md b/README.md
index 35037008e..a0abf9afa 100644
--- a/README.md
+++ b/README.md
@@ -31,7 +31,7 @@ $ yarn start
This command starts a local development server and opens up a browser window.
Most changes are reflected live without having to restart the server.
-## Building and Publishing
+## <a name="building"></a>Building and Publishing
It can be useful at times to start anew:
@@ -48,5 +48,18 @@ $ yarn build
This command generates static content into the `build` directory and can be
served using any static contents hosting service. We've GitHub Actions based
automation that can publish changes merged to 'main' branch being automatically
-published to the 'asf-site'.
+published to the 'asf-site'. see the procedure below.
+
+## publishing procedure
+
+- create a change
+- test your change according to [the previous chapter](#building)
+- create a PR against staging
+- merge
+- wait for the staged-site to be updated and published
+- check the staging site
+- merge staging-site to main
+- wait for asf-site to be updated and publised to the main site
+- check again
+- go to sleep
\ No newline at end of file
