chore: sync files (#520)

* chore: sync files Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * style(pre-commit): autofix --------- Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
autowarefoundation · Dec 21, 2024 · 25527c8 · 25527c8
1 parent 0f10c35
commit 25527c8
Show file tree

Hide file tree

Showing 18 changed files with 134 additions and 30 deletions.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 blank_issues_enabled: false
 contact_links:
   - name: Question

diff --git a/.github/ISSUE_TEMPLATE/task.yaml b/.github/ISSUE_TEMPLATE/task.yaml
@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: Task
 description: Plan a task
 body:

diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml
@@ -1,9 +1,14 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 version: 2
 updates:
   - package-ecosystem: github-actions
     directory: /
+    # https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#scheduleinterval
     schedule:
-      interval: daily
+      interval: monthly
     open-pull-requests-limit: 1
     labels:
       - tag:bot

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,11 @@
+## Description
+
+## How was this PR tested?
+
+## Notes for reviewers
+
+None.
+
+## Effects on system behavior
+
+None.
diff --git a/.github/stale.yml b/.github/stale.yml
@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 # Modified from https://github.com/probot/stale#usage
 
 # Number of days of inactivity before an Issue or Pull Request with the stale label is closed

diff --git a/.github/workflows/comment-on-pr.yaml b/.github/workflows/comment-on-pr.yaml
@@ -0,0 +1,29 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
+name: comment-on-pr
+on:
+  pull_request_target:
+
+jobs:
+  comment-on-pr:
+    runs-on: ubuntu-22.04
+    permissions:
+      pull-requests: write
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Initial PR comment
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          message: |
+            Thank you for contributing to the Autoware project!
+
+            🚧 If your pull request is in progress, [switch it to draft mode](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#converting-a-pull-request-to-a-draft).
+
+            Please ensure:
+            - You've checked our [contribution guidelines](https://autowarefoundation.github.io/autoware-documentation/main/contributing/).
+            - Your PR follows our [pull request guidelines](https://autowarefoundation.github.io/autoware-documentation/main/contributing/pull-request-guidelines/).
+            - All required CI checks pass before [marking the PR ready for review](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#marking-a-pull-request-as-ready-for-review).
diff --git a/.github/workflows/github-release.yaml b/.github/workflows/github-release.yaml
@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: github-release
 
 on:
@@ -15,7 +19,7 @@ on:
 
 jobs:
   github-release:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - name: Set tag name
         id: set-tag-name

diff --git a/.github/workflows/pre-commit-optional.yaml b/.github/workflows/pre-commit-optional.yaml
@@ -1,11 +1,15 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: pre-commit-optional
 
 on:
   pull_request:
 
 jobs:
   pre-commit-optional:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - name: Check out repository
         uses: actions/checkout@v4

diff --git a/.github/workflows/pre-commit.yaml b/.github/workflows/pre-commit.yaml
@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: pre-commit
 
 on:
@@ -6,11 +10,11 @@ on:
 jobs:
   pre-commit:
     if: ${{ github.event.repository.private }} # Use pre-commit.ci for public repositories
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - name: Generate token
         id: generate-token
-        uses: tibdex/github-app-token@v1
+        uses: tibdex/github-app-token@v2
         with:
           app_id: ${{ secrets.APP_ID }}
           private_key: ${{ secrets.PRIVATE_KEY }}

diff --git a/.github/workflows/semantic-pull-request.yaml b/.github/workflows/semantic-pull-request.yaml
@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: semantic-pull-request
 
 on:

diff --git a/.github/workflows/spell-check-differential.yaml b/.github/workflows/spell-check-differential.yaml
@@ -1,16 +1,23 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: spell-check-differential
 
 on:
   pull_request:
 
 jobs:
   spell-check-differential:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - name: Check out repository
         uses: actions/checkout@v4
 
       - name: Run spell-check
         uses: autowarefoundation/autoware-github-actions/spell-check@v1
         with:
-          cspell-json-url: https://raw.githubusercontent.com/tier4/autoware-spell-check-dict/main/.cspell.json
+          cspell-json-url: https://raw.githubusercontent.com/autowarefoundation/autoware-spell-check-dict/main/.cspell.json
+          dict-packages: |
+            https://github.com/autowarefoundation/autoware-spell-check-dict
+            https://github.com/tier4/cspell-dicts
diff --git a/.github/workflows/sync-files.yaml b/.github/workflows/sync-files.yaml
@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: sync-files
 
 on:
@@ -14,11 +18,11 @@ jobs:
   sync-files:
     needs: check-secret
     if: ${{ needs.check-secret.outputs.set == 'true' }}
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - name: Generate token
         id: generate-token
-        uses: tibdex/github-app-token@v1
+        uses: tibdex/github-app-token@v2
         with:
           app_id: ${{ secrets.APP_ID }}
           private_key: ${{ secrets.PRIVATE_KEY }}

diff --git a/.markdownlint.yaml b/.markdownlint.yaml
@@ -1,12 +1,16 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 # See https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md for all rules.
 default: true
 MD013: false
 MD024:
   siblings_only: true
 MD029:
   style: ordered
-MD030: false
 MD033: false
 MD041: false
+MD045: false
 MD046: false
 MD049: false
diff --git a/.pre-commit-config-optional.yaml b/.pre-commit-config-optional.yaml
@@ -1,6 +1,10 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 repos:
   - repo: https://github.com/tcort/markdown-link-check
-    rev: v3.11.2
+    rev: v3.12.2
     hooks:
       - id: markdown-link-check
         args: [--quiet, --config=.markdown-link-check.json]
diff --git a/.prettierignore b/.prettierignore
@@ -1,2 +1,6 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 *.param.yaml
 *.rviz
diff --git a/.prettierrc.yaml b/.prettierrc.yaml
@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 printWidth: 100
 tabWidth: 2
 overrides:

diff --git a/.yamllint.yaml b/.yamllint.yaml
@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 extends: default
 
 ignore: |

diff --git a/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md b/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md
@@ -51,37 +51,37 @@
 
     If you prefer a graphical user interface (GUI) over the command line for launching and managing your simulations, refer to the `Using Autoware Launch GUI` section at the end of this document for a step-by-step guide.
 
-1.  Launch Autoware.
+1. Launch Autoware.
 
-    ```sh
-    source ~/autoware/install/setup.bash
-    ros2 launch autoware_launch logging_simulator.launch.xml map_path:=$HOME/autoware_map/sample-map-rosbag vehicle_model:=sample_vehicle sensor_model:=sample_sensor_kit
-    ```
+   ```sh
+   source ~/autoware/install/setup.bash
+   ros2 launch autoware_launch logging_simulator.launch.xml map_path:=$HOME/autoware_map/sample-map-rosbag vehicle_model:=sample_vehicle sensor_model:=sample_sensor_kit
+   ```
 
-    Note that you cannot use `~` instead of `$HOME` here.
+   Note that you cannot use `~` instead of `$HOME` here.
 
-    ![after-autoware-launch](images/rosbag-replay/after-autoware-launch.png)
+   ![after-autoware-launch](images/rosbag-replay/after-autoware-launch.png)
 
-    > ⚠️ You might encounter error and warning messages in the terminal before playing the `rosbag`. This is normal behavior. These should cease once the `rosbag` is played and proper initialization takes place
+   > ⚠️ You might encounter error and warning messages in the terminal before playing the `rosbag`. This is normal behavior. These should cease once the `rosbag` is played and proper initialization takes place
 
-2.  Play the sample rosbag file.
+2. Play the sample rosbag file.
 
-    ```sh
-    source ~/autoware/install/setup.bash
-    ros2 bag play ~/autoware_map/sample-rosbag/ -r 0.2 -s sqlite3
-    ```
+   ```sh
+   source ~/autoware/install/setup.bash
+   ros2 bag play ~/autoware_map/sample-rosbag/ -r 0.2 -s sqlite3
+   ```
 
-    > ⚠️ Due to the discrepancy between the timestamp in the `rosbag` and the current system timestamp, Autoware may generate warning messages in the terminal alerting to this mismatch. This is normal behavior.
+   > ⚠️ Due to the discrepancy between the timestamp in the `rosbag` and the current system timestamp, Autoware may generate warning messages in the terminal alerting to this mismatch. This is normal behavior.
 
-    ![after-rosbag-play](images/rosbag-replay/after-rosbag-play.png)
+   ![after-rosbag-play](images/rosbag-replay/after-rosbag-play.png)
 
-3.  To focus the view on the ego vehicle, change the `Target Frame` in the RViz Views panel from `viewer` to `base_link`.
+3. To focus the view on the ego vehicle, change the `Target Frame` in the RViz Views panel from `viewer` to `base_link`.
 
-    ![change-target-frame](images/rosbag-replay/change-target-frame.png)
+   ![change-target-frame](images/rosbag-replay/change-target-frame.png)
 
-4.  To switch the view to `Third Person Follower` etc, change the `Type` in the RViz Views panel.
+4. To switch the view to `Third Person Follower` etc, change the `Type` in the RViz Views panel.
 
-    ![third-person-follower](images/rosbag-replay/third-person-follower.png)
+   ![third-person-follower](images/rosbag-replay/third-person-follower.png)
 
 [Reference video tutorials](https://drive.google.com/file/d/12D6aSC1Y3Kf7STtEPWG5RYynxKdVcPrc/view?usp=sharing)