This is an automated email from the ASF dual-hosted git repository.
dockerzhang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-inlong.git
The following commit(s) were added to refs/heads/master by this push:
new 2a045c64f [INLONG-4201][CI] Improve workflows and documentation (#4202)
2a045c64f is described below
commit 2a045c64f3e4d186966862466a5ad5363828f2c8
Author: Yuanhao Ji <[email protected]>
AuthorDate: Sun May 15 10:56:33 2022 +0800
[INLONG-4201][CI] Improve workflows and documentation (#4202)
---
.github/workflows/README.md | 60 ++++++++++++++++++++++++++++++++++
.github/workflows/ci_build.yml | 4 +--
.github/workflows/ci_chart_test.yml | 12 +++----
.github/workflows/ci_check_license.yml | 14 ++++----
.github/workflows/ci_docker.yml | 10 +++---
.github/workflows/ci_labeler.yml | 3 +-
.github/workflows/ci_ut.yml | 4 +--
7 files changed, 84 insertions(+), 23 deletions(-)
diff --git a/.github/workflows/README.md b/.github/workflows/README.md
new file mode 100644
index 000000000..5260abb5d
--- /dev/null
+++ b/.github/workflows/README.md
@@ -0,0 +1,60 @@
+## GitHub Workflows
+
+This directory contains all InLong CI checks.
+
+- [](https://github.com/apache/incubator-inlong/actions/workflows/ci_build.yml)
+
+ Build InLong when pushing changes or opening a pull request.
+
+ If it passes, you can download the InLong binary package from the workflow
run's URL.
+
+- [](https://github.com/apache/incubator-inlong/actions/workflows/ci_ut.yml)
+
+ Unit testing when pushing changes or opening a pull request.
+
+ If it fails, you can check out reports form the workflow run's URL.
+
+- [](https://github.com/apache/incubator-inlong/actions/workflows/ci_docker.yml)
+
+ Build Docker images when pushing changes or opening a pull request.
+
+ Only when pushing changes to the `apache/incubator-inlong` repository will
the Docker images are pushed to [Docker Hub](https://hub.docker.com/u/inlong).
+
+- [](https://github.com/apache/incubator-inlong/actions/workflows/ci_chart_test.yml)
+
+ Lint and test the InLong Helm Chart when pushing changes or opening a pull
request.
+
+ In this workflow, firstly, install [Helm](https://helm.sh) using the
[azure/setup-helm](https://github.com/Azure/setup-helm) action,
+ then install [chart-testing](https://github.com/helm/chart-testing) using
the [helm/chart-testing-action](https://github.com/helm/chart-testing-action)
+ and install [Kind](https://github.com/kubernetes-sigs/kind) using the
[helm/kind-action](https://github.com/helm/kind-action),
+ finally, use the chart-testing tool to lint and install the InLong Helm
Chart.
+ And here is the [chart-testing configuration](../ct.yml) and here is the
[kind configuration](../kind.yml).
+
+ > NOTE: If the charts have not changed, they will not be linted, validated,
installed and tested.
+
+- [](https://github.com/apache/incubator-inlong/actions/workflows/ci_check_license.yml)
+
+ Check licence header when pushing changes or opening a pull request using
the [apache/skywalking-eyes](https://github.com/apache/skywalking-eyes) action.
+ And here is the [configuration](../../.licenserc.yaml).
+
+- [](https://github.com/apache/incubator-inlong/actions/workflows/ci_labeler.yml)
+
+ label new pull requests based on the paths of files being changed using the
[actions/labeler](https://github.com/actions/labeler) action.
+ And here is the [labeler configuration](../labeler.yml)
+
+- [](https://github.com/apache/incubator-inlong/actions/workflows/ci_stale.yml)
+
+ Mark issues and pull requests that have not had recent interaction using the
[actions/stale](https://github.com/actions/stale) action.
+
+- [](https://github.com/apache/incubator-inlong/actions/workflows/ci_greeting.yml)
+
+ Interact with newcomers using the
[actions/first-interaction](https://github.com/actions/first-interaction)
action.
+
+### Troubleshooting
+
+If you have any questions, welcome to contact the maintainers. And feel free
to make a [pull request](https://github.com/apache/incubator-inlong/compare)!
+
+### Maintainers
+
+- [dockerzhang](https://github.com/dockerzhang)
+- [shink](https://github.com/shink)
diff --git a/.github/workflows/ci_build.yml b/.github/workflows/ci_build.yml
index b296d4e35..2d1ec3de6 100644
--- a/.github/workflows/ci_build.yml
+++ b/.github/workflows/ci_build.yml
@@ -58,7 +58,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
- uses: actions/checkout@v2
+ uses: actions/checkout@v3
- name: Set up JDK
uses: actions/setup-java@v3
@@ -81,7 +81,7 @@ jobs:
env:
CI: false
- - name: Get inlong version
+ - name: Get InLong version
if: ${{ success() }}
run: |
version=`mvn -Dexec.executable='echo'
-Dexec.args='${project.version}' --non-recursive exec:exec -q`
diff --git a/.github/workflows/ci_chart_test.yml
b/.github/workflows/ci_chart_test.yml
index 4e1a35e30..70a2c97e1 100644
--- a/.github/workflows/ci_chart_test.yml
+++ b/.github/workflows/ci_chart_test.yml
@@ -53,17 +53,17 @@ jobs:
- 'kindest/node:v1.23.4'
steps:
- name: Checkout
- uses: actions/checkout@v2
+ uses: actions/checkout@v3
with:
fetch-depth: 0
submodules: true
- - name: Set up helm
+ - name: Set up Helm
uses: azure/setup-helm@v1
with:
version: v3.5.0
- - name: Set up python
+ - name: Set up Python
uses: actions/setup-python@v2
with:
python-version: 3.7
@@ -77,16 +77,16 @@ jobs:
changed=$(ct list-changed --config ${{ env.CT_CONFIG_PATH }}
--target-branch ${{ github.event.repository.default_branch }})
if [[ -n "$changed" ]]; then
echo "::set-output name=changed::true"
- echo -e "\e[96mchanged charts: $changed\e[0m"
+ echo "Changed charts: $changed"
else
- echo -e "\e[91mCharts are not changed, they will not be linted,
validated, installed and tested.\e[0m"
+ echo "Charts are not changed, they will not be linted, validated,
installed and tested."
fi
# NOTE: If the charts have not changed, they will not be linted,
validated, installed and tested.
- name: Lint and validate charts
run: ct lint --config ${{ env.CT_CONFIG_PATH }}
- - name: Create kind cluster
+ - name: Create Kind cluster
if: ${{ steps.list-changed.outputs.changed == 'true' }}
uses: ./.github/actions/kind-action
with:
diff --git a/.github/workflows/ci_check_license.yml
b/.github/workflows/ci_check_license.yml
index ae84e0891..64846918f 100644
--- a/.github/workflows/ci_check_license.yml
+++ b/.github/workflows/ci_check_license.yml
@@ -20,17 +20,17 @@ name: InLong Check License Header
on: [ push, pull_request ]
jobs:
- build:
- name: Check License Header
+ check-license:
+ name: Check license header
runs-on: ubuntu-latest
steps:
- name: Checkout
- uses: actions/checkout@v2
+ uses: actions/checkout@v3
- - name: Check License Header
- uses: apache/skywalking-eyes@2f5c0bce5575a25916d6b809c4dac84e6c750d47
- env:
- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ - name: Check license header
+ uses: apache/[email protected]
with:
log: info
config: .licenserc.yaml
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/ci_docker.yml b/.github/workflows/ci_docker.yml
index 4b40d7451..9a1cff868 100644
--- a/.github/workflows/ci_docker.yml
+++ b/.github/workflows/ci_docker.yml
@@ -54,11 +54,11 @@ on:
jobs:
docker:
- name: Docker Build and Push
+ name: Docker build and push
runs-on: ubuntu-latest
steps:
- name: Checkout
- uses: actions/checkout@v2
+ uses: actions/checkout@v3
- name: Set up JDK
uses: actions/setup-java@v3
@@ -80,13 +80,13 @@ jobs:
key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
restore-keys: ${{ runner.os }}-m2
- - name: Build docker image
+ - name: Build Docker images
run: mvn --batch-mode --update-snapshots -e -V clean package
-DskipTests -Pdocker
env:
CI: false
# If the changes are being pushed to the master branch or a branch like
'release-1.0.0', this step will output true.
- - name: Match Branch
+ - name: Match branch
id: match-branch
if: |
success()
@@ -97,7 +97,7 @@ jobs:
echo "::set-output name=match::true"
fi
- - name: Push docker image to Docker Hub
+ - name: Push Docker images to Docker Hub
if: ${{ success() && steps.match-branch.outputs.match == 'true' }}
working-directory: docker
run: bash +x publish.sh
diff --git a/.github/workflows/ci_labeler.yml b/.github/workflows/ci_labeler.yml
index 358f27c31..2d0cbd579 100644
--- a/.github/workflows/ci_labeler.yml
+++ b/.github/workflows/ci_labeler.yml
@@ -24,7 +24,8 @@ jobs:
name: Label
runs-on: ubuntu-latest
steps:
- - uses: actions/labeler@v4
+ - name: Label the PR
+ uses: actions/labeler@v4
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
configuration-path: .github/labeler.yml
diff --git a/.github/workflows/ci_ut.yml b/.github/workflows/ci_ut.yml
index bb2dd7396..e3f78a3ca 100644
--- a/.github/workflows/ci_ut.yml
+++ b/.github/workflows/ci_ut.yml
@@ -58,7 +58,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
- uses: actions/checkout@v2
+ uses: actions/checkout@v3
- name: Set up JDK
uses: actions/setup-java@v3
@@ -99,4 +99,4 @@ jobs:
with:
name: failsafe-reports
path: ./**/target/failsafe-reports/
- if-no-files-found: ignore
\ No newline at end of file
+ if-no-files-found: ignore
