diff --git a/.github/sync-files.yaml b/.github/sync-files.yaml index 4519f1b3..8c41463c 100644 --- a/.github/sync-files.yaml +++ b/.github/sync-files.yaml @@ -6,7 +6,7 @@ - source: LICENSE - source: .github/dependabot.yaml - source: .github/workflows/pre-commit-optional.yaml - - source: .github/workflows/spell-check.yaml + - source: .github/workflows/spell-check-differential.yaml - source: .markdown-link-check.json - source: .markdownlint.yaml - source: .pre-commit-config-optional.yaml diff --git a/.github/workflows/actions-tagger.yaml b/.github/workflows/actions-tagger.yaml new file mode 100644 index 00000000..d725103c --- /dev/null +++ b/.github/workflows/actions-tagger.yaml @@ -0,0 +1,13 @@ +name: actions-tagger + +on: + release: + types: + - published + - edited + +jobs: + actions-tagger: + runs-on: ubuntu-latest + steps: + - uses: Actions-R-Us/actions-tagger@v2 diff --git a/.github/workflows/automatic-rebase.yaml b/.github/workflows/automatic-rebase.yaml deleted file mode 100644 index 8f6dc2b3..00000000 --- a/.github/workflows/automatic-rebase.yaml +++ /dev/null @@ -1,29 +0,0 @@ -name: automatic-rebase - -on: - issue_comment: - types: - - created - -jobs: - automatic-rebase: - if: ${{ github.event.issue.pull_request != '' && contains(github.event.comment.body, '/rebase') }} - runs-on: ubuntu-latest - steps: - - name: Generate token - id: generate-token - uses: tibdex/github-app-token@v1 - with: - app_id: ${{ secrets.APP_ID }} - private_key: ${{ secrets.PRIVATE_KEY }} - - - name: Check out repository - uses: actions/checkout@v2 - with: - token: ${{ steps.generate-token.outputs.token }} - fetch-depth: 0 - - - name: Automatic rebase - uses: cirrus-actions/rebase@1.5 - env: - GITHUB_TOKEN: ${{ steps.generate-token.outputs.token }} diff --git a/.github/workflows/github-release.yaml b/.github/workflows/github-release.yaml new file mode 100644 index 00000000..6c04d39d --- /dev/null +++ b/.github/workflows/github-release.yaml @@ -0,0 +1,28 @@ +name: github-release + +on: + push: + tags: + - v* + +jobs: + github-release: + runs-on: ubuntu-latest + steps: + - name: Check out repository + uses: actions/checkout@v2 + with: + fetch-depth: 0 + + - name: Run generate-changelog + id: generate-changelog + uses: autowarefoundation/autoware-github-actions/generate-changelog@tier4/proposal + + - name: Release to GitHub + run: | + echo "Release ${{ github.ref_name }}" + gh release create "${{ github.ref_name }}" \ + --draft \ + --notes "${{ steps.generate-changelog.outputs.changelog }}" + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/semantic-pull-request.yaml b/.github/workflows/semantic-pull-request.yaml index b1f66a7d..2390048c 100644 --- a/.github/workflows/semantic-pull-request.yaml +++ b/.github/workflows/semantic-pull-request.yaml @@ -30,5 +30,6 @@ jobs: revert subjectPattern: ^(?![A-Z]).+$ validateSingleCommit: true + validateSingleCommitMatchesPrTitle: true env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/spell-check.yaml b/.github/workflows/spell-check-differential.yaml similarity index 86% rename from .github/workflows/spell-check.yaml rename to .github/workflows/spell-check-differential.yaml index 43a75891..484c3690 100644 --- a/.github/workflows/spell-check.yaml +++ b/.github/workflows/spell-check-differential.yaml @@ -1,10 +1,10 @@ -name: spell-check +name: spell-check-differential on: pull_request: jobs: - spell-check: + spell-check-differential: runs-on: ubuntu-latest steps: - name: Check out repository diff --git a/.github/workflows/test-composite-actions.yaml b/.github/workflows/test-composite-actions.yaml index 0c703ba7..24555195 100644 --- a/.github/workflows/test-composite-actions.yaml +++ b/.github/workflows/test-composite-actions.yaml @@ -139,3 +139,33 @@ jobs: - name: Check result run: | [[ "${{ steps.check-file-existence4.outputs.exists }}" == "true" ]] + + test-colcon-build-and-colcon-test: + runs-on: ubuntu-latest + container: ros:${{ matrix.rosdistro }} + strategy: + fail-fast: false + matrix: + rosdistro: + - galactic + steps: + - name: Check out repository + uses: actions/checkout@v2 + + - name: Create a package with no source files + run: | + . /opt/ros/${{ matrix.rosdistro }}/setup.sh + ros2 pkg create --build-type ament_cmake empty_target_cmake + ros2 pkg create --build-type ament_python empty_target_python + + - name: Run colcon-build + uses: ./colcon-build + with: + rosdistro: ${{ matrix.rosdistro }} + target-packages: empty_target_cmake empty_target_python + + - name: Run colcon-test + uses: ./colcon-test + with: + rosdistro: ${{ matrix.rosdistro }} + target-packages: empty_target_cmake empty_target_python diff --git a/.prettierignore b/.prettierignore index f7405807..a3c34d00 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1 +1,2 @@ *.param.yaml +*.rviz diff --git a/.yamllint.yaml b/.yamllint.yaml index 1d4ee33e..6228c70f 100644 --- a/.yamllint.yaml +++ b/.yamllint.yaml @@ -5,6 +5,9 @@ ignore: | *.param.yaml rules: + braces: + level: error + max-spaces-inside: 1 # To format with Prettier comments: level: error min-spaces-from-content: 1 # To be compatible with C++ and Python diff --git a/clang-tidy/README.md b/clang-tidy/README.md index f66a9337..13ba061d 100644 --- a/clang-tidy/README.md +++ b/clang-tidy/README.md @@ -35,10 +35,10 @@ jobs: | Name | Required | Description | | --------------------- | -------- | --------------------------------------------------- | -| rosdistro | true | ROS distro. | +| rosdistro | true | The ROS distro. | | target-packages | true | The target packages to analyse by Clang-Tidy. | | clang-tidy-config-url | true | The URL to `.clang-tidy`. | -| build-depends-repos | false | `.repos` file that includes build dependencies. | +| build-depends-repos | false | The `.repos` file that includes build dependencies. | | token | false | The token for build dependencies and `.clang-tidy`. | ## Outputs diff --git a/clang-tidy/action.yaml b/clang-tidy/action.yaml index a0a4ba27..120ecfcd 100644 --- a/clang-tidy/action.yaml +++ b/clang-tidy/action.yaml @@ -60,9 +60,10 @@ runs: - name: Run rosdep install run: | + package_paths=$(colcon list -p --packages-above-and-dependencies ${{ inputs.target-packages }}) sudo apt-get -yqq update rosdep update - DEBIAN_FRONTEND=noninteractive rosdep install -yqq --from-paths . --ignore-src --rosdistro ${{ inputs.rosdistro }} + DEBIAN_FRONTEND=noninteractive rosdep install -yqq --from-paths ${package_paths} --ignore-src --rosdistro ${{ inputs.rosdistro }} shell: bash - name: Restore build files from cache diff --git a/cliff.toml b/cliff.toml index a9b28885..b4d7ad65 100644 --- a/cliff.toml +++ b/cliff.toml @@ -25,7 +25,7 @@ body = """ {% endfor %} {% endfor %}\n """ -# remove the leading and trailing whitespaces from the template +# remove the leading and trailing whitespace from the template trim = true # changelog footer footer = """ @@ -41,21 +41,28 @@ commit_parsers = [ # Skip { message = "^chore\\(release\\)", skip = true}, # Comply with https://github.com/commitizen/conventional-commit-types/blob/c3a9be4c73e47f2e8197de775f41d981701407fb/index.json - { message = "^feat", group = "Features"}, - { message = "^fix", group = "Bug Fixes"}, - { message = "^doc", group = "Documentation"}, - { message = "^style", group = "Styles"}, - { message = "^refactor", group = "Code Refactoring"}, - { message = "^perf", group = "Performance Improvements"}, - { message = "^test", group = "Tests"}, - { message = "^build", group = "Builds"}, - { message = "^ci", group = "Continuous Integrations"}, - { message = "^chore", group = "Chores"}, - { message = "^revert", group = "Reverts"}, + # Why adding numbers to groups is in https://github.com/orhun/git-cliff/issues/9#issuecomment-914521594 + { message = "^feat", group = "Features"}, + { message = "^fix", group = "Bug Fixes"}, + { message = "^doc", group = "Documentation"}, + { message = "^style", group = "Styles"}, + { message = "^refactor", group = "Code Refactoring"}, + { message = "^perf", group = "Performance Improvements"}, + { message = "^test", group = "Tests"}, + { message = "^build", group = "Builds"}, + { message = "^ci", group = "Continuous Integrations"}, + { message = "^chore", group = "Chores"}, + { message = "^revert", group = "Reverts"}, ] # filter out the commits that are not matched by commit parsers filter_commits = false # glob pattern for matching git tags tag_pattern = "v[0-9]*" # regex for skipping tags -skip_tags = "v.*-beta.*" +skip_tags = "v0.0.0" +# regex for ignoring tags +ignore_tags = "v.*-beta.*" +# sort the tags chronologically +date_order = false +# sort the commits inside sections by oldest/newest order +sort_commits = "oldest" diff --git a/colcon-build-and-test/README.md b/colcon-build-and-test/README.md index 7e7417d4..50d25335 100644 --- a/colcon-build-and-test/README.md +++ b/colcon-build-and-test/README.md @@ -1,4 +1,4 @@ -# colcon-build-and-test +# DEPRECATED: colcon-build-and-test This action runs `colcon build` and `colcon test`. @@ -30,12 +30,12 @@ jobs: ## Inputs -| Name | Required | Description | -| ------------------- | -------- | ----------------------------------------------- | -| rosdistro | true | ROS distro. | -| target-packages | true | The target packages to build and test. | -| build-depends-repos | false | `.repos` file that includes build dependencies. | -| token | false | The token for build dependencies. | +| Name | Required | Description | +| ------------------- | -------- | --------------------------------------------------- | +| rosdistro | true | The ROS distro. | +| target-packages | true | The target packages to build and test. | +| build-depends-repos | false | The `.repos` file that includes build dependencies. | +| token | false | The token for build dependencies. | ## Outputs diff --git a/colcon-build-and-test/action.yaml b/colcon-build-and-test/action.yaml index c0942a7f..8ec98ebd 100644 --- a/colcon-build-and-test/action.yaml +++ b/colcon-build-and-test/action.yaml @@ -19,6 +19,10 @@ inputs: runs: using: composite steps: + - name: Show deprecated warning + run: echo "::warning title=DEPRECATED::colcon-build-and-test action will no longer be available in future releases. Please consider using colcon-build and colcon-test workflows instead." + shell: bash + - name: Show target packages run: | echo "target packages: ${{ inputs.target-packages }}" @@ -45,9 +49,10 @@ runs: - name: Run rosdep install run: | + package_paths=$(colcon list -p --packages-above-and-dependencies ${{ inputs.target-packages }}) sudo apt-get -yqq update rosdep update - DEBIAN_FRONTEND=noninteractive rosdep install -yqq --from-paths . --ignore-src --rosdistro ${{ inputs.rosdistro }} + DEBIAN_FRONTEND=noninteractive rosdep install -yqq --from-paths ${package_paths} --ignore-src --rosdistro ${{ inputs.rosdistro }} shell: bash - name: Set up colcon-mixin diff --git a/colcon-build/README.md b/colcon-build/README.md new file mode 100644 index 00000000..bc400d9d --- /dev/null +++ b/colcon-build/README.md @@ -0,0 +1,42 @@ +# colcon-build + +This action runs `colcon build`. + +## Usage + +```yaml +jobs: + build: + runs-on: ubuntu-latest + container: ros:galactic + steps: + - name: Check out repository + uses: actions/checkout@v2 + with: + fetch-depth: 0 + + - name: Get modified packages + id: get-modified-packages + uses: autowarefoundation/autoware-github-actions/get-modified-packages@tier4/proposal + + - name: Build + if: ${{ steps.get-modified-packages.outputs.modified-packages != '' }} + uses: autowarefoundation/autoware-github-actions/colcon-build@tier4/proposal + with: + rosdistro: galactic + target-packages: ${{ steps.get-modified-packages.outputs.modified-packages }} + build-depends-repos: build_depends.repos +``` + +## Inputs + +| Name | Required | Description | +| ------------------- | -------- | --------------------------------------------------- | +| rosdistro | true | ROS distro. | +| target-packages | true | The target packages to build. | +| build-depends-repos | false | The `.repos` file that includes build dependencies. | +| token | false | The token for build dependencies. | + +## Outputs + +None. diff --git a/colcon-build/action.yaml b/colcon-build/action.yaml new file mode 100644 index 00000000..111ddc50 --- /dev/null +++ b/colcon-build/action.yaml @@ -0,0 +1,75 @@ +name: colcon-build +description: "" + +inputs: + rosdistro: + description: "" + required: true + target-packages: + description: "" + required: true + build-depends-repos: + description: "" + required: false + token: + description: "" + required: false + default: ${{ github.token }} + +runs: + using: composite + steps: + - name: Show target packages + run: | + echo "target packages: ${{ inputs.target-packages }}" + shell: bash + + - name: Install pip for rosdep + run: | + sudo apt-get -yqq update + sudo apt-get -yqq install python3-pip + shell: bash + + - name: Set git config + if: ${{ inputs.build-depends-repos != '' }} + uses: autowarefoundation/autoware-github-actions/set-git-config@tier4/proposal + with: + token: ${{ inputs.token }} + + - name: Clone dependency packages + if: ${{ inputs.build-depends-repos != '' }} + run: | + mkdir dependency_ws + vcs import dependency_ws < ${{ inputs.build-depends-repos }} + shell: bash + + - name: Run rosdep install + run: | + package_paths=$(colcon list -p --packages-above-and-dependencies ${{ inputs.target-packages }}) + sudo apt-get -yqq update + rosdep update + DEBIAN_FRONTEND=noninteractive rosdep install -yqq --from-paths ${package_paths} --ignore-src --rosdistro ${{ inputs.rosdistro }} + shell: bash + + - name: Set up colcon-mixin + run: | + colcon mixin add default https://raw.githubusercontent.com/colcon/colcon-mixin-repository/master/index.yaml || true + colcon mixin update default + shell: bash + + - name: Build + run: | + . /opt/ros/${{ inputs.rosdistro }}/setup.sh + colcon build --event-handlers console_cohesion+ \ + --packages-above-and-dependencies ${{ inputs.target-packages }} \ + --cmake-args -DCMAKE_BUILD_TYPE=Release \ + --mixin coverage-gcc coverage-pytest compile-commands + shell: bash + + - name: Cache build artifacts + uses: actions/cache@v2 + with: + path: | + ./build + ./install + key: build-${{ github.sha }} diff --git a/colcon-test/README.md b/colcon-test/README.md new file mode 100644 index 00000000..6c6473e4 --- /dev/null +++ b/colcon-test/README.md @@ -0,0 +1,86 @@ +# colcon-test + +This action runs `colcon test` with labels specified in a regex format. +Note that you need to build target packages before running this action. + +## Usage + +```yaml +jobs: + build: + runs-on: ubuntu-latest + container: ros:galactic + steps: + - name: Check out repository + uses: actions/checkout@v2 + with: + fetch-depth: 0 + + - name: Get modified packages + id: get-modified-packages + uses: autowarefoundation/autoware-github-actions/get-modified-packages@tier4/proposal + + - name: Build + if: ${{ steps.get-modified-packages.outputs.modified-packages != '' }} + uses: autowarefoundation/autoware-github-actions/colcon-build@tier4/proposal + with: + rosdistro: galactic + target-packages: ${{ steps.get-modified-packages.outputs.modified-packages }} + build-depends-repos: build_depends.repos + + test: + needs: build + runs-on: ubuntu-latest + container: ros:galactic + strategy: + matrix: + include: + - test-label: gtest + codecov-flags: gtest + - test-label: launch_test + codecov-flags: launch_test + steps: + - name: Check out repository + uses: actions/checkout@v2 + with: + fetch-depth: 0 + + - name: Get modified packages + id: get-modified-packages + uses: autowarefoundation/autoware-github-actions/get-modified-packages@tier4/proposal + + - name: Test + id: test + if: ${{ steps.get-modified-packages.outputs.modified-packages != '' }} + uses: autowarefoundation/autoware-github-actions/colcon-test@tier4/proposal + with: + rosdistro: galactic + target-packages: ${{ steps.get-modified-packages.outputs.modified-packages }} + build-depends-repos: build_depends.repos + label-regex: ${{ matrix.test-label }} + + - name: Upload coverage to Codecov + if: ${{ steps.test.outputs.coverage-report-files != '' }} + uses: codecov/codecov-action@v2 + with: + files: ${{ steps.test.outputs.coverage-report-files }} + fail_ci_if_error: false + verbose: true + flags: ${{ matrix.codecov-flags }} +``` + +## Inputs + +| Name | Required | Description | +| ------------------- | -------- | --------------------------------------------------- | +| rosdistro | true | ROS distro. | +| target-packages | true | The target packages to test. | +| build-depends-repos | false | The `.repos` file that includes build dependencies. | +| label-regex | false | The regex pattern of test labels to be run. | +| token | false | The token for build dependencies. | + +## Outputs + +| Name | Description | +| --------------------- | -------------------------------- | +| coverage-report-files | Generated coverage report files. | diff --git a/colcon-test/action.yaml b/colcon-test/action.yaml new file mode 100644 index 00000000..414712c4 --- /dev/null +++ b/colcon-test/action.yaml @@ -0,0 +1,135 @@ +name: colcon-test +description: "" + +inputs: + rosdistro: + description: "" + required: true + target-packages: + description: "" + required: true + build-depends-repos: + description: "" + required: false + label-regex: + description: "" + required: false + default: .* # Run all tests + token: + description: "" + required: false + default: ${{ github.token }} +outputs: + coverage-report-files: + description: "" + value: ${{ steps.test.outputs.coverage-reports }} + +runs: + using: composite + steps: + - name: Show target packages + run: | + echo "target packages: ${{ inputs.target-packages }}" + shell: bash + + - name: Set up colcon-mixin + run: | + colcon mixin add default https://raw.githubusercontent.com/colcon/colcon-mixin-repository/master/index.yaml || true + colcon mixin update default + shell: bash + + - name: Install packages for coverage commands + run: | + sudo apt-get -yqq update + sudo apt-get -yqq install lcov python3-pip + pip3 install colcon-lcov-result colcon-coveragepy-result + shell: bash + + - name: Set git config + if: ${{ inputs.build-depends-repos != '' }} + uses: autowarefoundation/autoware-github-actions/set-git-config@tier4/proposal + with: + token: ${{ inputs.token }} + + - name: Clone dependency packages + if: ${{ inputs.build-depends-repos != '' }} + run: | + mkdir dependency_ws + vcs import dependency_ws < ${{ inputs.build-depends-repos }} + shell: bash + + - name: Run rosdep install + run: | + package_paths=$(colcon list -p --packages-above-and-dependencies ${{ inputs.target-packages }}) + sudo apt-get -yqq update + rosdep update + DEBIAN_FRONTEND=noninteractive rosdep install -yqq --from-paths ${package_paths} --ignore-src --rosdistro ${{ inputs.rosdistro }} + shell: bash + + - name: Restore build files from cache + id: restore-build-files + uses: actions/cache@v2 + with: + path: | + ./build + ./install + key: build-${{ github.sha }} + + - name: Test + run: | + set -e + . /opt/ros/${{ inputs.rosdistro }}/setup.sh + + colcon lcov-result --zero-counters \ + --verbose \ + --packages-above ${{ inputs.target-packages }} + + colcon lcov-result --initial \ + --verbose \ + --packages-above ${{ inputs.target-packages }} + + colcon test --event-handlers console_cohesion+ \ + --mixin coverage-pytest \ + --packages-above ${{ inputs.target-packages }} \ + --ctest-args -L "${{ inputs.label-regex }}" \ + --return-code-on-test-failure + + colcon lcov-result \ + --verbose \ + --packages-above ${{ inputs.target-packages }} || true + + colcon coveragepy-result \ + --verbose \ + --packages-above ${{ inputs.target-packages }} || true + shell: bash + + - name: Check lcov coverage file exists + id: lcov-coverage-file-existence + uses: autowarefoundation/autoware-github-actions/check-file-existence@tier4/proposal + with: + files: lcov/total_coverage.info + condition: and + + - name: Check coveragepy coverage file exists + id: coveragepy-coverage-file-existence + uses: autowarefoundation/autoware-github-actions/check-file-existence@tier4/proposal + with: + files: coveragepy/.coverage + condition: and + + - name: Generate output + id: test + run: | + coverage_files=() + if [[ "${{ steps.lcov-coverage-file-existence.outputs.exists }}" == "true" ]]; then + coverage_files+=("lcov/total_coverage.info") + fi + + if [[ "${{ steps.coveragepy-coverage-file-existence.outputs.exists}}" == "true" ]]; then + coverage_files+=("coveragepy/.coverage") + fi + + # Join coverage file names + coverage_files_str="$(IFS=,; echo "${coverage_files[*]}")" + echo ::set-output name=coverage-reports::$coverage_files_str + shell: bash diff --git a/generate-changelog/README.md b/generate-changelog/README.md new file mode 100644 index 00000000..c617082e --- /dev/null +++ b/generate-changelog/README.md @@ -0,0 +1,42 @@ +# generate-changelog + +## Description + +This action generates the changelog using [git-cliff](https://github.com/orhun/git-cliff). + +## Usage + +```yaml +jobs: + generate-changelog: + runs-on: ubuntu-latest + steps: + - name: Check out repository + uses: actions/checkout@v2 + with: + fetch-depth: 0 + + - name: Run generate-changelog + id: generate-changelog + uses: autowarefoundation/autoware-github-actions/generate-changelog@tier4/proposal + + - name: Show result + run: | + echo "$CHANGELOG" + env: + CHANGELOG: ${{ steps.generate-changelog.outputs.changelog }} +``` + +## Inputs + +| Name | Required | Description | +| --------------------- | -------- | -------------------------------------------------------- | +| git-cliff-args | false | The arguments for the `git-cliff` command. | +| git-cliff-config | false | The path to the `git-cliff` config file. | +| trim-version-and-date | false | Whether to trim the version and date from the changelog. | + +## Outputs + +| Name | Description | +| --------- | ------------------------ | +| changelog | The generated changelog. | diff --git a/generate-changelog/action.yaml b/generate-changelog/action.yaml new file mode 100644 index 00000000..9f5d125a --- /dev/null +++ b/generate-changelog/action.yaml @@ -0,0 +1,56 @@ +name: generate-changelog +description: "" + +inputs: + git-cliff-args: + description: "" + required: false + default: --current + git-cliff-config: + description: "" + required: false + default: ${GITHUB_ACTION_PATH}/../cliff.toml + trim-version-and-date: + description: "" + required: false + default: "true" +outputs: + changelog: + description: "" + value: ${{ steps.generate-changelog.outputs.changelog }} + +runs: + using: composite + steps: + - name: Set up git-cliff + uses: kenji-miyake/setup-git-cliff@main + + - name: Generate changelog + id: generate-changelog + shell: bash + run: | + # Generate changelog + git cliff --output CHANGELOG.md --config ${{ inputs.git-cliff-config }} \ + -vv --strip header ${{ inputs.git-cliff-args }} + + r=$(cat CHANGELOG.md) + rm CHANGELOG.md + + # Trim version and date + if [ "${{ inputs.trim-version-and-date }}" = "true" ]; then + r="$(printf "$r" | tail -n +3)" + fi + + # Workaround for https://github.community/t/set-output-truncates-multiline-strings/16852 + r="${r//'%'/'%25'}" + r="${r//$'\n'/'%0A'}" + r="${r//$'\r'/'%0D'}" + + echo "::set-output name=changelog::$r" + + - name: Show result + run: | + echo "$CHANGELOG" + env: + CHANGELOG: ${{ steps.generate-changelog.outputs.changelog }} + shell: bash diff --git a/get-modified-packages/README.md b/get-modified-packages/README.md index a0c9337d..64dd64b4 100644 --- a/get-modified-packages/README.md +++ b/get-modified-packages/README.md @@ -25,6 +25,6 @@ None. ## Outputs -| Name | Description | -| ----------------- | ----------------------------------------------------- | -| modified-packages | The list of ROS packages modified in the pull request | +| Name | Description | +| ----------------- | ------------------------------------------------------ | +| modified-packages | The list of ROS packages modified in the pull request. | diff --git a/get-modified-packages/get-modified-packages.sh b/get-modified-packages/get-modified-packages.sh index 39ad8527..11d279ce 100755 --- a/get-modified-packages/get-modified-packages.sh +++ b/get-modified-packages/get-modified-packages.sh @@ -28,13 +28,6 @@ function find_package_dir() { target_dir=$(dirname "$1") while true; do - parent_dir=$(dirname "$target_dir") - - # Exit if no parent found - if [ "$parent_dir" = "$target_dir" ]; then - return 0 - fi - # Output package name if package.xml found if [ -f "$target_dir/package.xml" ]; then if [ ! -f "$target_dir/COLCON_IGNORE" ]; then @@ -43,6 +36,12 @@ function find_package_dir() { fi fi + # Exit if no parent found + parent_dir=$(dirname "$target_dir") + if [ "$parent_dir" = "$target_dir" ]; then + return 0 + fi + # Move to parent dir target_dir=$parent_dir done diff --git a/git-cliff/git-cliff-0.5.0/CHANGELOG.md b/git-cliff/git-cliff-0.5.0/CHANGELOG.md new file mode 100644 index 00000000..faa6ca38 --- /dev/null +++ b/git-cliff/git-cliff-0.5.0/CHANGELOG.md @@ -0,0 +1,527 @@ +# Changelog +All notable changes to this project will be documented in this file. + +## [0.5.0] - 2021-12-15 + +### Bug Fixes + +- Update log test about exclude path +- Override the sort related config if args are present (#39) +- Checkout the repository before running fixtures +- Use the defined configuration file for fixtures +- Update the multi line docker command +- Strip the carriage return on fixtures while comparing +- Drop the skipped releases from 'previous' field + +### Documentation + +- Update `--with-commit` example in README.md + +### Features + +- Add `--topo-order` flag for sorting tags (#29) +- Support specifying the sorting methods in config (#31) +- Accept glob patterns for `--commit-path` argument +- Support multiple values for `--commit-path` argument +- Add `--exclude-path` argument for excluding related commits +- Add `--current` flag for processing the current tag (#37) +- Add `ignore_tags` option (#40) +- Use more explanatory error messages about templates +- Support having both conventional and unconventional commits in the changelog +- Add `--with-commit` argument for including custom commit messages in changelog + +### Miscellaneous Tasks + +- Improve the workflow for test fixtures +- Run test fixtures on ubuntu-latest +- Indicate the breaking changes via default config + +### Refactor + +- Rename the config value for commit order + +### Styling + +- [**breaking**] Rename `--commit-path` argument to `--include-path` + +## [0.4.2] - 2021-10-22 + +### Bug Fixes + +- Install the Rust toolchain explicitly for crates.io releases + +## [0.4.1] - 2021-10-22 + +### Bug Fixes + +- Add support for special characters in scopes (#26) + +### Documentation + +- Add GitLab CI/CD section to README.md (#24) +- Update GitLab CI/CD section + +### Miscellaneous Tasks + +- Run CI workflows periodically +- Remove unnecessary Cargo.lock entry from .gitignore +- Upgrade dependencies +- Migrate to Rust 2021 edition +- Bump the Rust version in Dockerfile + +### Refactor + +- Use a better error message for invalid repo path + +## [0.4.0] - 2021-10-01 + +### Bug Fixes + +- Update lychee arguments to skip checking files +- Remove tags from the base image names +- Remove only the leading "v" from tags (#18) + +### Documentation + +- Add scope-sorted example (#16) +- Add raw/rendered output for scoped-sorted example +- Add packaging status badge to installation section +- Mention the signing key for binary releases (#17) +- Add "build from source" section to README.md + +### Features + +- Add `--sort` argument for sorting commits (#15) + +### Miscellaneous Tasks + +- Set a version for the checkout action +- Update the runner to ubuntu-20.04 +- Use cache for docker builds +- Use docker meta for tagging for GHCR +- Extend the tags for docker meta +- Rename the GHCR package due to legacy reasons +- Specify the latest tag explicitly +- Use explicit image name for docker automated builds +- Use docker.yml workflow for CI/CD +- Upgrade dependencies + +### Styling + +- Fix the newline issues in scoped-sorted example + +## [0.3.0] - 2021-09-10 + +### Bug Fixes + +- Fix default regexes and references in docs (#7) + +### Documentation + +- Update installation instructions for Arch Linux +- Add badge for joining the Matrix chat +- Update example regexes +- Update the default regex in scoped config example + +### Features + +- Support parsing the missing scopes with `default_scope` (#8) +- Support generating a changelog scoped to a directory (#11) + +### Miscellaneous Tasks + +- Upgrade dependencies + +## [0.2.6] - 2021-09-04 + +### Bug Fixes + +- Pin the cargo-chef version in Dockerfile + +### Documentation + +- Update docker commands to only mount the .git directory + +### Miscellaneous Tasks + +- Bump `git-conventional` to `0.10.1` (fixes #6) +- Bump dependencies +- Bump cargo-chef version in Dockerfile + +## [0.2.5] - 2021-08-20 + +### Documentation + +- Mention breaking changes for templating +- Update template examples to mention how to contribute + +### Features + +- Add `breaking_description` to the template context (#4) + +### Miscellaneous Tasks + +- Show the committed changes before creating a tag + +## [0.2.4] - 2021-08-20 + +### Bug Fixes + +- Change the config file location for crates.io release + +## [0.2.3] - 2021-08-18 + +### Bug Fixes + +- Fetch the dependencies before copying the file to embed + +## [0.2.2] - 2021-08-18 + +### Bug Fixes + +- Copy the config file into registry to resolve it for embed + +## [0.2.1] - 2021-08-18 + +### Bug Fixes + +- Copy the configuration file to embed into package + +## [0.2.0] - 2021-08-18 + +### Bug Fixes + +- Use custom error type for UTF-8 errors + +### Documentation + +- Update the doc comment of `prepend` + +### Features + +- Embed the default configuration file into the binary +- Add `--init` flag for creating the default config +- Support a global location for configuration file (#2) + +### Miscellaneous Tasks + +- Move `cliff.toml` to config/ + +### Refactor + +- Create a constant for default configuration file +- Update the log message for unprocessed tags + +### Styling + +- Update the message of `--init` flag + +## [0.1.2] - 2021-08-14 + +### Bug Fixes + +- Use the correct name of completions binary + +### Documentation + +- Update the example completion command + +## [0.1.1] - 2021-08-14 + +### Bug Fixes + +- Set the previous release when using `--latest` (#3) + +### Documentation + +- Add installation instructions for the AUR + +### Miscellaneous Tasks + +- Rename the shell completions binary +- Upgrade dependencies + +### Performance + +- Process only the last 'previous' release +- Optimize the release vector size + +## [0.1.0] - 2021-08-12 + +### Bug Fixes + +- Update the environment variable parsing settings +- Use footers field as an array for the context +- Sort the commits in topological order +- Return error if there is not a latest tag to process +- Update symbolic link to the default config +- Remove symbolic link +- Use 7 digits for short SHA + +### Documentation + +- Update README.md about usage +- Update README.md about template and examples +- Add examples for CLI usage +- Add examples for templating +- Update detailed template example +- Add preview image to README.md + +### Miscellaneous Tasks + +- Upgrade dependencies +- Remove etc directory from .gitignore +- Bump the rust version +- Upgrade dependencies + +### Refactor + +- Rename changelog argument to prepend + +### Styling + +- Center the badges +- Update the comments in template context +- Remove comments from template context +- Wrap table of contents into summary +- Remove quotes from rendered output + +### Testing + +- Add tests +- Update repository tests about getting the latest tag + +## [0.1.0-rc.21] - 2021-07-01 + +### Bug Fixes + +- Wait for core library to update on crates.io before publish + +## [0.1.0-rc.20] - 2021-06-30 + +### Bug Fixes + +- Wait between publishing crates + +## [0.1.0-rc.19] - 2021-06-30 + +### Bug Fixes + +- Generate changelog on a dedicated/different job + +### Miscellaneous Tasks + +- Update project details + +## [0.1.0-rc.18] - 2021-06-30 + +### Bug Fixes + +- Use a separate step for setting the changelog body +- Fix the syntax of publish step arguments + +## [0.1.0-rc.17] - 2021-06-29 + +### Bug Fixes + +- Publish the cargo workspace members seperately + +### Miscellaneous Tasks + +- Verify the created tag after creation +- Indicate which versions are managed by the script + +## [0.1.0-rc.16] - 2021-06-29 + +### Bug Fixes + +- Update lychee arguments to exclude invalid links + +### Documentation + +- Add CONTRIBUTING.md +- Add link to the signer key of the tag +- Add RELEASE.md + +### Miscellaneous Tasks + +- Enable crates.io releases +- Set the new version in release script + +## [0.1.0-rc.15] - 2021-06-23 + +### Miscellaneous Tasks + +- Use only one step for uploading releases + +## [0.1.0-rc.14] - 2021-06-23 + +### Bug Fixes + +- Strip the changelog header before escaping + +## [0.1.0-rc.13] - 2021-06-23 + +### Miscellaneous Tasks + +- Use seperate steps for uploading releases + +## [0.1.0-rc.12] - 2021-06-21 + +### Bug Fixes + +- Use printf to prevent field splitting the variable +- Fix the character escape in release script +- Return tags by their creation order + +### Miscellaneous Tasks + +- Update .editorconfig about shell scripts +- Include the commit id in the custom template + +## [0.1.0-rc.11] - 2021-06-21 + +### Miscellaneous Tasks + +- Remove the custom changelog template + +### Refactor + +- Use custom error message for GroupError + +## [0.1.0-rc.10] - 2021-06-20 + +### Styling + +- Update the order of entries in config + +## [0.1.0-rc.8] - 2021-06-20 + +### Bug Fixes + +- Specify the committer email in release script +- Double quote the environment variable + +### Miscellaneous Tasks + +- Rename the docker automated builds action + +## [0.1.0-rc.7] - 2021-06-20 + +### Features + +- Support setting the body template via args + +### Miscellaneous Tasks + +- Set a custom changelog for the tag message +- Override the changelog template + +## [0.1.0-rc.6] - 2021-06-20 + +### Miscellaneous Tasks + +- Set the release body on linux + +## [0.1.0-rc.5] - 2021-06-19 + +### Bug Fixes + +- Update config to skip release commits + +## [0.1.0-rc.4] - 2021-06-19 + +### Revert + +- Chore(config): update template to include commit ids + +## [0.1.0-rc.3] - 2021-06-19 + +### Bug Fixes + +- Strip the unreleased title from tag message +- Update commit parsers to match the commit type + +### Miscellaneous Tasks + +- Fix setting the release body +- Update the skip_tags regex +- Update template to include commit ids + +## [0.1.0-rc.2] - 2021-06-19 + +### Bug Fixes + +- Use default tag_pattern for tests + +### Features + +- Add `--output` argument + +### Miscellaneous Tasks + +- Add release title to the tag message +- Set the release name explicitly +- Remove user directive from Dockerfile +- Set the changelog as release body + +### Refactor + +- Make tag_pattern optional + +## [0.1.0-rc.1] - 2021-06-16 + +### Documentation + +- Update the doc comment for completions script +- Add usage section + +### Features + +- Add `--workdir` argument +- Show the processsed commit message + +### Miscellaneous Tasks + +- Add release script +- Update the release script about arguments +- Strip the markdown format from tag message + +### Refactor + +- Update the value name for `--strip` +- Improve logging +- Update value names and description + +## [0.1.0-beta.4] - 2021-06-14 + +### Bug Fixes + +- Use bash while setting the release version + +### Miscellaneous Tasks + +- Add docker releases + +## [0.1.0-beta.3] - 2021-06-14 + +### Bug Fixes + +- Include configuration file in the binary releases +- Specify the bash as shell + +### Miscellaneous Tasks + +- Set the release body text + +## [0.1.0-beta.2] - 2021-06-14 + +### Bug Fixes + +- Install musl-tools for musl builds + +### Miscellaneous Tasks + +- Update config + + diff --git a/git-cliff/git-cliff-0.5.0/LICENSE b/git-cliff/git-cliff-0.5.0/LICENSE new file mode 100644 index 00000000..f288702d --- /dev/null +++ b/git-cliff/git-cliff-0.5.0/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/git-cliff/git-cliff-0.5.0/README.md b/git-cliff/git-cliff-0.5.0/README.md new file mode 100644 index 00000000..541a39d6 --- /dev/null +++ b/git-cliff/git-cliff-0.5.0/README.md @@ -0,0 +1,1242 @@ +

+ + +
+ + + + + + + + + +
+ + + + + + + + + + + + +
+ + + +

+ +## About + +**git-cliff** can generate [changelog](https://en.wikipedia.org/wiki/Changelog) files from the [Git](https://git-scm.com/) history by utilizing [conventional commits](#conventional_commits) as well as regex-powered [custom parsers](#commit_parsers). The [changelog template](#templating) can be customized with a [configuration file](#configuration-file) to match the desired format. + +![preview](https://user-images.githubusercontent.com/24392180/128637997-5713ba25-d8f3-40c7-8ba8-ea7f333ead88.png) + +
+ Table of Contents + +- [About](#about) +- [Installation](#installation) + - [From crates.io](#from-cratesio) + - [Using pacman](#using-pacman) + - [Binary releases](#binary-releases) + - [Build from source](#build-from-source) +- [Usage](#usage) + - [Command Line Arguments](#command-line-arguments) + - [Examples](#examples) +- [Docker](#docker) +- [GitHub Action](#github-action) +- [GitLab CI/CD](#gitlab-cicd) +- [Configuration File](#configuration-file) + - [changelog](#changelog) + - [header](#header) + - [body](#body) + - [trim](#trim) + - [footer](#footer) + - [git](#git) + - [conventional_commits](#conventional_commits) + - [filter_unconventional](#filter_unconventional) + - [commit_parsers](#commit_parsers) + - [filter_commits](#filter_commits) + - [tag_pattern](#tag_pattern) + - [skip_tags](#skip_tags) + - [ignore_tags](#ignore_tags) + - [topo_order](#topo_order) + - [sort_commits](#sort_commits) +- [Templating](#templating) + - [Context](#context) + - [Conventional Commits](#conventional-commits) + - [Breaking Changes](#breaking-changes) + - [Non-Conventional Commits](#non-conventional-commits) + - [Syntax](#syntax) + - [Examples](#examples-1) + - [Basic](#basic) + - [Detailed](#detailed) + - [Scoped](#scoped) + - [Scoped (Sorted)](#scoped-sorted) + - [Keep a Changelog](#keep-a-changelog) + - [Unconventional](#unconventional) +- [Similar Projects](#similar-projects) +- [License](#license) +- [Copyright](#copyright) + +
+ +## Installation + +
+ Packaging status + +[![Packaging status](https://repology.org/badge/vertical-allrepos/git-cliff.svg)](https://repology.org/project/git-cliff/versions) + +
+ +### From crates.io + +[git-cliff](crates.io/crates/git-cliff) can be installed from crates.io: + +```sh +cargo install git-cliff +``` + +### Using pacman + +If you are using Arch Linux, **git-cliff** can be installed from the [community repository](https://archlinux.org/packages/community/x86_64/git-cliff/): + +```sh +pacman -S git-cliff +``` + +### Binary releases + +See the available binaries for different operating systems/architectures from the [releases page](https://github.com/orhun/git-cliff/releases). + +\* Release tarballs are signed with the following PGP key: [1D2D410A741137EBC544826F4A92FA17B6619297](https://keyserver.ubuntu.com/pks/lookup?search=0x4A92FA17B6619297&op=vindex) + +### Build from source + +* Linux dependencies: [zlib](https://zlib.net/) + +```sh +# binary will be located at `target/release/git-cliff` +CARGO_TARGET_DIR=target cargo build --release +``` + +## Usage + +### Command Line Arguments + +``` +git-cliff [FLAGS] [OPTIONS] [RANGE] +``` + +**Flags:** + +``` +-v, --verbose Increases the logging verbosity +-i, --init Writes the default configuration file to cliff.toml +-l, --latest Processes the commits starting from the latest tag + --current Processes the commits that belong to the current tag +-u, --unreleased Processes the commits that do not belong to a tag + --topo-order Sorts the tags topologically +-h, --help Prints help information +-V, --version Prints version information +``` + +**Options:** + +``` +-c, --config Sets the configuration file [env: CONFIG=] [default: cliff.toml] +-w, --workdir Sets the working directory [env: WORKDIR=] +-r, --repository Sets the git repository [env: REPOSITORY=] + --include-path ... Sets the path to include related commits [env: INCLUDE_PATH=] + --exclude-path ... Sets the path to exclude related commits [env: EXCLUDE_PATH=] + --with-commit ... Sets custom commit messages to include in the changelog [env: WITH_COMMIT=] +-p, --prepend Prepends entries to the given changelog file [env: PREPEND= +-o, --output Writes output to the given file [env: OUTPUT=] +-t, --tag Sets the tag for the latest version [env: TAG=] +-b, --body