This is an automated email from the ASF dual-hosted git repository.
ricardozanini pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-kie-kogito-docs.git
The following commit(s) were added to refs/heads/main by this push:
new 9060377f2 Fix #537 - Add surge.sh preview GHA (#539)
9060377f2 is described below
commit 9060377f21ef5a12426dd669281ee75968a51432
Author: Ricardo Zanini <[email protected]>
AuthorDate: Wed Mar 6 14:12:53 2024 -0300
Fix #537 - Add surge.sh preview GHA (#539)
---
.github/workflows/jenkins-tests-PR.yml | 18 +++---
.github/workflows/npm-publish-pages.yml | 52 ++++++++---------
.github/workflows/pr-backporting.yml | 6 +-
.github/workflows/pr-preview-build.yml | 68 ++++++++++++++++++++++
.github/workflows/pr-preview-publish.yml | 67 +++++++++++++++++++++
...enkins-tests-PR.yml => pr-preview-teardown.yml} | 36 ++++++------
.github/workflows/sw-docs-pr.yml | 15 ++---
antora-playbook-author.yml | 3 +
.../ROOT/pages/core/custom-functions-support.adoc | 6 +-
9 files changed, 205 insertions(+), 66 deletions(-)
diff --git a/.github/workflows/jenkins-tests-PR.yml
b/.github/workflows/jenkins-tests-PR.yml
index 879dfc43a..dac4f93eb 100644
--- a/.github/workflows/jenkins-tests-PR.yml
+++ b/.github/workflows/jenkins-tests-PR.yml
@@ -22,9 +22,9 @@
name: Jenkins Tests
on:
pull_request:
- paths:
- - '.ci/jenkins/**'
- - '.github/workflows/jenkins-tests-PR.yml'
+ paths:
+ - ".ci/jenkins/**"
+ - ".github/workflows/jenkins-tests-PR.yml"
jobs:
dsl-tests:
@@ -33,9 +33,9 @@ jobs:
cancel-in-progress: true
runs-on: ubuntu-latest
steps:
- - name: DSL tests
- uses: kiegroup/kie-ci/.ci/actions/dsl-tests@main
- with:
- main-config-file-repo: apache/incubator-kie-kogito-pipelines
- main-config-file-path: .ci/jenkins/config/main.yaml
- branch-config-file-repo: apache/incubator-kie-kogito-pipelines
+ - name: DSL tests
+ uses: apache/incubator-kie-kogito-pipelines/.ci/actions/dsl-tests@main
+ with:
+ main-config-file-repo: apache/incubator-kie-kogito-pipelines
+ main-config-file-path: .ci/jenkins/config/main.yaml
+ branch-config-file-repo: apache/incubator-kie-kogito-pipelines
diff --git a/.github/workflows/npm-publish-pages.yml
b/.github/workflows/npm-publish-pages.yml
index 43d01dc4e..7a15dd7ac 100644
--- a/.github/workflows/npm-publish-pages.yml
+++ b/.github/workflows/npm-publish-pages.yml
@@ -20,7 +20,7 @@
# This workflow will run tests using node and then publish a package to GitHub
Packages when a release is created
# For more information see:
https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
-name: Node.js Publish webpage
+name: Node.js Publish SonataFlow Docs
on:
push:
@@ -34,7 +34,6 @@ permissions:
jobs:
build:
-
runs-on: ubuntu-latest
strategy:
@@ -43,30 +42,29 @@ jobs:
# See supported Node.js release schedule at
https://nodejs.org/en/about/releases/
steps:
- - name: Checkout main branch
- uses: actions/checkout@v3
- with:
- ref: main
-
- - name: Use Node.js ${{ matrix.node-version }}
- uses: actions/setup-node@v3
- with:
- node-version: ${{ matrix.node-version }}
-# cache: 'npm'
+ - name: Checkout main branch
+ uses: actions/checkout@v3
+ with:
+ ref: main
+
+ - name: Use Node.js ${{ matrix.node-version }}
+ uses: actions/setup-node@v3
+ with:
+ node-version: ${{ matrix.node-version }}
+
+ - name: Build the pages
+ run: npm run install-build
+
+ - name: Setup Python
+ uses: actions/setup-python@v4
+ with:
+ python-version: "3.10"
- - name: Build the pages
- run: npm run install-build
+ - name: Copy latest to numbered version
+ run: python scripts/copy-latest.py
- - name: Setup Python
- uses: actions/setup-python@v4
- with:
- python-version: '3.10'
-
- - name: Copy latest to numbered version
- run: python scripts/copy-latest.py
-
- - name: Publish to GitHub Pages
- uses: peaceiris/actions-gh-pages@v3
- with:
- github_token: ${{ secrets.GITHUB_TOKEN }}
- publish_dir: build/site
+ - name: Publish to GitHub Pages
+ uses: peaceiris/actions-gh-pages@v3
+ with:
+ github_token: ${{ secrets.GITHUB_TOKEN }}
+ publish_dir: build/site
diff --git a/.github/workflows/pr-backporting.yml
b/.github/workflows/pr-backporting.yml
index 899e108d3..d9c31c9de 100644
--- a/.github/workflows/pr-backporting.yml
+++ b/.github/workflows/pr-backporting.yml
@@ -39,14 +39,14 @@ jobs:
uses: kiegroup/kie-ci/.ci/actions/parse-labels@main
with:
labels: ${LABELS}
-
+
backporting:
if: ${{ github.event.pull_request.state == 'closed' &&
github.event.pull_request.merged &&
needs.compute-targets.outputs.target-branches != '[]' }}
name: "[${{ matrix.target-branch }}] - Backporting"
runs-on: ubuntu-latest
needs: compute-targets
strategy:
- matrix:
+ matrix:
target-branch: ${{
fromJSON(needs.compute-targets.outputs.target-branches) }}
fail-fast: false
env:
@@ -56,4 +56,4 @@ jobs:
uses: kiegroup/kie-ci/.ci/actions/backporting@main
with:
target-branch: ${{ matrix.target-branch }}
- additional-reviewers: ${REVIEWERS}
\ No newline at end of file
+ additional-reviewers: ${REVIEWERS}
diff --git a/.github/workflows/pr-preview-build.yml
b/.github/workflows/pr-preview-build.yml
new file mode 100644
index 000000000..1c6c3d4ae
--- /dev/null
+++ b/.github/workflows/pr-preview-build.yml
@@ -0,0 +1,68 @@
+#
+# 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: SonataFlow Guides Preview - Build
+
+on:
+ push:
+ branches:
+ - "main"
+ paths-ignore:
+ - ".gitignore"
+ - "LICENSE"
+ - "README*"
+ - "CONTRIBUTING.md"
+ pull_request:
+ paths-ignore:
+ - ".gitignore"
+ - "LICENSE"
+ - "README*"
+ - "CONTRIBUTING.md"
+jobs:
+ build_site:
+ name: "Building WebSite with Antora"
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v4
+
+ - name: Setup Node.js
+ uses: actions/setup-node@v4
+ with:
+ node-version: "16"
+
+ - name: Set environment variables
+ run: |
+ echo "DOCSEARCH_ENABLED=true" >> $GITHUB_ENV
+ echo "DOCSEARCH_ENGINE=lunr" >> $GITHUB_ENV
+ echo "NODE_PATH=$(npm -g root)" >> $GITHUB_ENV
+
+ - name: Check Node.js version
+ run: npm -v
+
+ - name: Install dependencies and build
+ run: npm run local-install-build
+
+ - name: Publishing directory for PR preview
+ if: github.event_name == 'pull_request'
+ uses: actions/upload-artifact@v4
+ with:
+ name: site
+ path: ./build/site
+ retention-days: 3
diff --git a/.github/workflows/pr-preview-publish.yml
b/.github/workflows/pr-preview-publish.yml
new file mode 100644
index 000000000..daf95ab88
--- /dev/null
+++ b/.github/workflows/pr-preview-publish.yml
@@ -0,0 +1,67 @@
+#
+# 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: SonataFlow Guides Preview - Publish
+
+on:
+ workflow_run:
+ workflows: ["SonataFlow Guides Preview - Build"]
+ types:
+ - completed
+
+jobs:
+ preview:
+ name: "Publishing WebSite with Surge.sh"
+ if: github.event.workflow_run.event == 'pull_request' &&
github.event.workflow_run.conclusion == 'success'
+ runs-on: ubuntu-latest
+ steps:
+ - name: Download PR Artifact
+ uses: actions/download-artifact@v4
+ with:
+ name: site
+ run-id: ${{ github.event.workflow_run.workflow_id }}
+
+ - name: Publish to Surge for preview
+ id: deploy
+ run: npx surge ./build/site --domain
https://sonataflow-docs-preview-pr-${{ github.event.number }}.surge.sh --token
${{ secrets.SURGE_LOCAL_TOKEN }}
+
+ - name: Update PR status comment on success
+ if: success()
+ uses: actions-cool/maintain-one-comment@v3
+ with:
+ token: ${{ secrets.GITHUB_TOKEN }}
+ body: |
+ 🎊 PR Preview ${{ github.sha }} has been successfully built and
deployed. See the documentation preview: https://sonataflow-docs-preview-pr-${{
github.event.number }}.surge.sh
+ <!-- Sticky Pull Request Comment -->
+ body-include: "<!-- Sticky Pull Request Comment -->"
+ number: ${{ github.event.number }}
+ emojis: "heart"
+
+ - name: Update PR status comment on failure
+ if: failure()
+ uses: actions-cool/maintain-one-comment@v3
+ with:
+ token: ${{ secrets.GITHUB_TOKEN }}
+ body: |
+ 😠Deploy PR Preview failed.
+ <img width="300"
src="https://user-images.githubusercontent.com/507615/90250824-4e066700-de6f-11ea-8230-600ecc3d6a6b.png";>
+ <!-- Sticky Pull Request Comment -->
+ body-include: "<!-- Sticky Pull Request Comment -->"
+ number: ${{ github.event.number }}
+ emojis: "confused"
diff --git a/.github/workflows/jenkins-tests-PR.yml
b/.github/workflows/pr-preview-teardown.yml
similarity index 53%
copy from .github/workflows/jenkins-tests-PR.yml
copy to .github/workflows/pr-preview-teardown.yml
index 879dfc43a..5dedd0dbb 100644
--- a/.github/workflows/jenkins-tests-PR.yml
+++ b/.github/workflows/pr-preview-teardown.yml
@@ -17,25 +17,27 @@
# under the License.
#
-# This workflow will build a Java project with Maven
-# For more information see:
https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
-name: Jenkins Tests
+name: SonataFlow Guides Preview - Teardown
+
on:
- pull_request:
- paths:
- - '.ci/jenkins/**'
- - '.github/workflows/jenkins-tests-PR.yml'
+ pull_request_target:
+ paths:
+ - "*.adoc"
+ types: [closed]
jobs:
- dsl-tests:
- concurrency:
- group: ${{ github.repository.name }}_dsl_tests-${{ github.head_ref }}
- cancel-in-progress: true
+ preview-teardown:
runs-on: ubuntu-latest
steps:
- - name: DSL tests
- uses: kiegroup/kie-ci/.ci/actions/dsl-tests@main
- with:
- main-config-file-repo: apache/incubator-kie-kogito-pipelines
- main-config-file-path: .ci/jenkins/config/main.yaml
- branch-config-file-repo: apache/incubator-kie-kogito-pipelines
+ - name: Teardown surge preview
+ id: deploy
+ run: npx surge teardown https://sonataflow-docs-preview-pr-${{
github.event.number }}.surge.sh --token ${{ secrets.SURGE_TOKEN }}
+ - name: Update PR status comment
+ uses: actions-cool/maintain-one-comment@v3
+ with:
+ token: ${{ secrets.GITHUB_TOKEN }}
+ body: |
+ 🙈 The PR is closed and the preview is expired.
+ <!-- Sticky Pull Request Comment -->
+ body-include: "<!-- Sticky Pull Request Comment -->"
+ number: ${{ github.event.number }}
diff --git a/.github/workflows/sw-docs-pr.yml b/.github/workflows/sw-docs-pr.yml
index 469a3394f..0cbdc45cd 100644
--- a/.github/workflows/sw-docs-pr.yml
+++ b/.github/workflows/sw-docs-pr.yml
@@ -17,27 +17,28 @@
# under the License.
#
-name: SonataFlow Guides
+name: SonataFlow Guides - Verify Build
on:
pull_request:
types: [opened, synchronize, reopened, ready_for_review]
branches: [main]
paths-ignore:
- - '.gitignore'
- - 'LICENSE'
- - 'README*'
+ - ".gitignore"
+ - "LICENSE"
+ - "README*"
+ - "CONTRIBUTING.md"
jobs:
build_site:
- name: "Building SonataFlow Guides with Antora"
+ name: "Building SonataFlow Docs with Antora"
runs-on: [ubuntu-latest]
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
- node-version: '16'
+ node-version: "16"
- run: export DOCSEARCH_ENABLED=true
- run: export DOCSEARCH_ENGINE=lunr
- run: export NODE_PATH="$(npm -g root)"
- run: npm -v
- - run: npm run install-build
+ - run: npm run local-install-build
diff --git a/antora-playbook-author.yml b/antora-playbook-author.yml
index c07423799..a2a26cc94 100644
--- a/antora-playbook-author.yml
+++ b/antora-playbook-author.yml
@@ -31,6 +31,9 @@ content:
- url: .
branches: HEAD
start_path: serverlessworkflow
+runtime:
+ log:
+ failure_level: warn
ui:
bundle:
url: ./antora/ui-bundle.zip
diff --git
a/serverlessworkflow/modules/ROOT/pages/core/custom-functions-support.adoc
b/serverlessworkflow/modules/ROOT/pages/core/custom-functions-support.adoc
index bd53207cb..6bbbee125 100644
--- a/serverlessworkflow/modules/ROOT/pages/core/custom-functions-support.adoc
+++ b/serverlessworkflow/modules/ROOT/pages/core/custom-functions-support.adoc
@@ -556,10 +556,10 @@ The following example shows the declaration of a `rest`
function:
<1> `multiplyAllAndSum` is the function name
<2> `custom` is the function type
-<3> `rest:post:/numbers/{multiplier}/multiplyByAndSum` is the custom operation
definition. In the custom operation definition:
+<3> `rest:post:/numbers/\{multiplier}/multiplyByAndSum` is the custom
operation definition. In the custom operation definition:
* `rest` is the reserved operation keyword that indicates this is a REST call.
* `post` is the HTTP method.
-* `/numbers/{multiplier}/multiplyByAndSum` is the relative endpoint.
+* `/numbers/\{multiplier}/multiplyByAndSum` is the relative endpoint.
When using the relative endpoints you must specify the host as a property. The
format of the host property is `kogito.sw.functions.<function_name>.host`.
Therefore, in this example, `kogito.sw.functions.multiplyAllByAndSum.host` is
the host property key. You might override the default port (80) if needed by
specifying `kogito.sw.functions.multiplyAllAndSum.port` property.
@@ -599,7 +599,7 @@ For example, given the following function definition that
performs a `get` reque
}
----
-You can replace `{category}` specifying an argument with that name, plus
adding `sort` query parameter
+You can replace `\{category}` specifying an argument with that name, plus
adding `sort` query parameter
.Example of a `get` request invocation
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
![https://user-images.githubusercontent.com/507615/90250824-4e066700-de6f-11ea-8230-600ecc3d6a6b.png"](https://user-images.githubusercontent.com/507615/90250824-4e066700-de6f-11ea-8230-600ecc3d6a6b.png"){kind=link}