Add CI and update README. (#141)

* Add CI to the project.

Signed-off-by: ChenYing Kuo <[email protected]>

* Update README.

Signed-off-by: ChenYing Kuo <[email protected]>

---------

Signed-off-by: ChenYing Kuo <[email protected]>

.github/release.yaml

@@ -0,0 +1,24 @@
+changelog:
+  exclude:
+    labels:
+      - duplicate
+      - wontfix
+      - invalid
+    authors:
+      - octocat
+  categories:
+    - title: "🛠️ Breaking Changes"
+      labels:
+        - "breaking change"
+    - title: "✨ Features"
+      labels:
+        - enhancement
+    - title: "🐛 Bug Fixes"
+      labels:
+        - bug
+    - title: "📚 Documentation"
+      labels:
+        - documentation
+    - title: "Other Changes"
+      labels:
+        - "*"

.github/workflows/ci.yaml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    paths:
+      - "src/**"
+      - "tests/**"
+      - "examples/**"
+      - "Cargo.*"
+      - ".github/**"
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+
+jobs:
+  markdown_lint:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: articulate/actions-markdownlint@v1
+        with:
+          config: .markdownlint.yaml
+          files: '*.md'
+          ignore: target
+          version: 0.28.1

.github/workflows/release.yaml

@@ -0,0 +1,56 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - v*
+  workflow_dispatch:
+
+concurrency:
+  group: "release-${{ github.head_ref || github.ref }}"
+  cancel-in-progress: true
+
+jobs:
+  ci:
+    uses: ./.github/workflows/ci.yaml
+
+  tag_release_artifacts:
+    # This only runs if this workflow is initiated via a tag-push with pattern 'v*'
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+    name: collect v-tag release artifacts
+    runs-on: ubuntu-latest
+    needs:
+      - ci
+    permissions: write-all
+    steps:
+      - uses: actions/checkout@v4
+
+      # README - we later need the download_url output of the upload step
+      - name: Upload README to release
+        uses: svenstaro/upload-release-action@v2
+        id: upload_readme
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: README.md
+          tag: ${{ github.ref }}
+
+      - name: Gets latest created release info
+        id: latest_release_info
+        uses: joutvhu/get-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Collect all artifacts
+        uses: anotherdaniel/[email protected]
+        id: quevee_manifest
+        with:
+          release_url: ${{ steps.latest_release_info.outputs.html_url }}
+          artifacts_readme: ${{ steps.upload_readme.outputs.browser_download_url }}
+
+      - name: Upload manifest to release
+        uses: svenstaro/upload-release-action@v2
+        id: upload_quality_manifest
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: ${{ steps.quevee_manifest.outputs.manifest_file }}
+          tag: ${{ github.ref }}

.markdownlint.yaml

@@ -0,0 +1,5 @@
+{
+  "MD013": false, # Line length limitation
+  "MD033": false, # Enable Inline HTML
+  "MD041": false, # Allow first line heading
+}

.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.41.0
+    hooks:
+    - id: markdownlint

README.md

@@ -1,7 +1,5 @@
 # autoware_carla_launch
 
-**Note: The main branch is not stable. Suggest using the branch [humble](https://github.com/evshary/autoware_carla_launch/tree/humble) instead.**
-
 The package includes launch file to run Autoware, Carla agent, and bridge ([zenoh-bridge-ros2dds](https://github.com/eclipse-zenoh/zenoh-plugin-ros2dds) + [zenoh_carla_bridge](https://github.com/evshary/zenoh_carla_bridge)).
 
 ## Useful link

docs/build.rst

@@ -37,6 +37,7 @@ Build the container for Zenoh+Autoware
 
     cd autoware_carla_launch
     source env.sh
+    # Note it will take some time first time initialize models used in Autoware
     make prepare_autoware
     make build_autoware
 

docs/index.rst

@@ -10,6 +10,13 @@ The package includes launch file to run Autoware, Carla agent, and bridges.
     :alt: Run multiple vehicles with Autoware Humble in Carla
     :target: https://youtu.be/lrFucLUWbDo
 
+Version
+-------
+
+* Autoware: 2024.09.03
+* Carla: 0.9.14
+* Zenoh: 1.0.2
+
 Contents
 --------