diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..d032367 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,33 @@ +name: ADR Tools + +on: + pull_request: + push: + branches: [main] + +jobs: + lint: + name: Lint + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + - uses: reviewdoc/action-setup + - run: reviewdog -version + + test: + name: Test - ${{ matrix.os }} + strategy: + fail-fast: false + matrix: + os: + - macos-latest + - ubuntu-latest + + runs-on: ${{ matrix.os }} + + steps: + - uses: actions/checkout@v4 + - name: Check results + run: make diff --git a/.github/workflows/reviewdog.yml b/.github/workflows/reviewdog.yml new file mode 100644 index 0000000..e97cf68 --- /dev/null +++ b/.github/workflows/reviewdog.yml @@ -0,0 +1,40 @@ +name: Reviewdog + +on: + pull_request: + +jobs: + markdownlint: + name: markdownlint + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: reviewdog/action-markdownlint@v0.24.0 + with: + reporter: github-pr-review + + shellcheck: + name: shellcheck + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: reviewdog/action-shellcheck@v1.26.0 + with: + reporter: github-pr-review + check_all_files_with_shebangs: 'true' + + typos: + name: typos + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: reviewdog/action-typos@v1.8.0 + + misspell: + name: misspell + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: reviewdog/action-misspell@v1.23.0 + with: + locale: UK diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index d306973..0000000 --- a/.travis.yml +++ /dev/null @@ -1,9 +0,0 @@ -language: bash - -os: - - linux - - osx - -script: make clean check - -sudo: false diff --git a/INSTALL.md b/INSTALL.md index 9846698..bdb6b9e 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -19,7 +19,7 @@ You can install with Git, if you want to be on the bleeding edge: ### Git for Windows: git bash -When using git bash within [Git for Windows][], the scripts can simply be put in +When using git bash within [Git for Windows][], the scripts can be put in `usr\bin` in the installation directory. That directory usually is `C:\Program Files\Git\usr\bin`. diff --git a/src/_adr_generate_table b/src/_adr_generate_table index 9facdaa..2c4b4d0 100644 --- a/src/_adr_generate_table +++ b/src/_adr_generate_table @@ -1,4 +1,4 @@ -#!/bin/bash +#!/usr/bin/env bash set -e eval "$("$(dirname "$0")"/adr-config)" diff --git a/src/_adr_help_config b/src/_adr_help_config index 09147ab..e03ff9b 100755 --- a/src/_adr_help_config +++ b/src/_adr_help_config @@ -1,4 +1,4 @@ -#!/bin/bash +#!/usr/bin/env bash set -e eval "$("$(dirname "$0")"/adr-config)" @@ -8,7 +8,7 @@ usage: adr config Displays the current configuration. The adr_template_dir parameter defaults to the adr installation -but can be overwriten if a custom template is required by settting the +but can be overwritten if a custom template is required by setting the ADR_TEMPLATE environment variable to the custom file. export ADR_TEMPLATE= diff --git a/src/adr-edit b/src/adr-edit index ccf6440..0f0f9fa 100755 --- a/src/adr-edit +++ b/src/adr-edit @@ -1,4 +1,4 @@ -#!/bin/bash +#!/usr/bin/env bash set -e eval "$("$(dirname "$0")"/adr-config)" diff --git a/src/adr-generate b/src/adr-generate index da9183c..412ce39 100755 --- a/src/adr-generate +++ b/src/adr-generate @@ -6,7 +6,7 @@ eval "$("$(dirname "$0")"/adr-config)" ## ## Generates summary documentation about the architecture decision records ## that is typically fed into the tool chain for publishing a project's -## documentatation. +## documentation. ## ## To list the report types that can be generated, run: ## diff --git a/tests/create-mutiple-records.expected b/tests/create-multiple-records.expected similarity index 100% rename from tests/create-mutiple-records.expected rename to tests/create-multiple-records.expected diff --git a/tests/create-mutiple-records.sh b/tests/create-multiple-records.sh similarity index 100% rename from tests/create-mutiple-records.sh rename to tests/create-multiple-records.sh