Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: sync files #520

Merged
merged 2 commits into from
Dec 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/task.yaml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
7 changes: 6 additions & 1 deletion .github/dependabot.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
11 changes: 11 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## Description

## How was this PR tested?

## Notes for reviewers

None.

## Effects on system behavior

None.
4 changes: 4 additions & 0 deletions .github/stale.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
29 changes: 29 additions & 0 deletions .github/workflows/comment-on-pr.yaml
Original file line number Diff line number Diff line change
@@ -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).
6 changes: 5 additions & 1 deletion .github/workflows/github-release.yaml
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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
Expand Down
6 changes: 5 additions & 1 deletion .github/workflows/pre-commit-optional.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 6 additions & 2 deletions .github/workflows/pre-commit.yaml
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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 }}
Expand Down
4 changes: 4 additions & 0 deletions .github/workflows/semantic-pull-request.yaml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
11 changes: 9 additions & 2 deletions .github/workflows/spell-check-differential.yaml
Original file line number Diff line number Diff line change
@@ -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
8 changes: 6 additions & 2 deletions .github/workflows/sync-files.yaml
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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 }}
Expand Down
6 changes: 5 additions & 1 deletion .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -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
6 changes: 5 additions & 1 deletion .pre-commit-config-optional.yaml
Original file line number Diff line number Diff line change
@@ -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]
4 changes: 4 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -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
4 changes: 4 additions & 0 deletions .prettierrc.yaml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
4 changes: 4 additions & 0 deletions .yamllint.yaml
Original file line number Diff line number Diff line change
@@ -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: |
Expand Down
38 changes: 19 additions & 19 deletions docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
Loading