Skip to content

Commit

Permalink
Merge branch 'add-installation-steps' into add-installation-of-tools-…
Browse files Browse the repository at this point in the history
…for-developers
  • Loading branch information
kenji-miyake authored Feb 18, 2022
2 parents dd12560 + c8209fd commit 8b48110
Show file tree
Hide file tree
Showing 5 changed files with 38 additions and 3 deletions.
1 change: 1 addition & 0 deletions .github/sync-files.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
- source: DISCLAIMER.md
- source: LICENSE
- source: .github/dependabot.yaml
- source: .github/workflows/pre-commit.yaml
- source: .github/workflows/pre-commit-optional.yaml
- source: .github/workflows/semantic-pull-request.yaml
- source: .github/workflows/spell-check-differential.yaml
Expand Down
16 changes: 16 additions & 0 deletions .github/workflows/pre-commit.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: pre-commit

on:
pull_request:

jobs:
pre-commit:
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v2

- name: Run pre-commit
uses: autowarefoundation/autoware-github-actions/pre-commit@tier4/proposal
with:
pre-commit-config: .pre-commit-config.yaml
16 changes: 16 additions & 0 deletions .github/workflows/spell-check-differential.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: spell-check-differential

on:
pull_request:

jobs:
spell-check-differential:
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v2

- name: Run spell-check
uses: autowarefoundation/autoware-github-actions/spell-check@tier4/proposal
with:
cspell-json-url: https://raw.githubusercontent.com/tier4/autoware-spell-check-dict/main/.cspell.json
2 changes: 1 addition & 1 deletion docs/installation/autoware/docker-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ WARNING: The requested image's platform (linux/arm64/v8) does not match the dete
aarch64
```

To run specify `arm64` architecture for Autoware's Docker images, add the suffix `-arm64`.
To run Autoware's Docker images of `arm64` architecture, add the suffix `-arm64`.
```sh-session
$ docker run --rm -it ghcr.io/autowarefoundation/autoware-universe:latest-arm64
Expand Down
6 changes: 4 additions & 2 deletions docs/installation/autoware/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,14 @@ There are two ways to set up Autoware. Choose one according to your preference.
Docker can ensure that all developers in a project have a common, consistent development environment.
It is recommended for beginners, light users, people who do not use Ubuntu.

See [here](autoware/docker-installation.md) for the detailed steps.
See [here](docker-installation.md) for the detailed steps.
Refer to [autowarefoundation/autoware/docker/README.md](https://github.com/autowarefoundation/autoware/blob/main/docker/README.md) as well.

## 2. Source installation

Source installation is for the cases where more granular control of the installation environment is needed.
It is recommended for skilled users or people who want to customize the environment.
Note that some problems may occur depending on your local environment.

See [here](autoware/source-installation.md) for the detailed steps.
See [here](source-installation.md) for the detailed steps.
Refer to the [autowarefoundation/autoware/README.md](https://github.com/autowarefoundation/autoware/blob/main/README.md) as well.

0 comments on commit 8b48110

Please sign in to comment.