Create reusable-pre-commit.yml and add workflow for it
#10
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| name: Format | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| pull_request: | ||
|
|
||
| jobs: | ||
| pre-commit: | ||
| uses: ./.github/workflows/reusable-pre-commit.yml | ||
| with: | ||
| ros_distro: rolling |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| name: Pre-commit | ||
| # The pre-commit configuration is in .pre-commit-config.yaml | ||
| # we don't use the pre-commit action because it doesn't support local hooks in its virtual environment | ||
|
|
||
| on: | ||
| workflow_call: | ||
| inputs: | ||
| ros_distro: | ||
| description: 'ROS2 distribution name' | ||
| required: true | ||
| type: string | ||
| os_name: | ||
| description: 'On which OS to run the linter' | ||
| required: false | ||
| default: 'ubuntu-latest' | ||
| type: string | ||
|
|
||
| jobs: | ||
| pre-commit: | ||
| runs-on: ${{ inputs.os_name }} | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: ros-tooling/[email protected] | ||
| - uses: actions/cache@v4 | ||
| with: | ||
| path: ~/.cache/pre-commit | ||
| key: pre-commit-3|${{ inputs.ros_distro }}|${{ hashFiles('.pre-commit-config.yaml') }} | ||
| - name: Install system hooks and run pre-commit | ||
| run: | | ||
| sudo apt-get install -qq ros-${{ inputs.ros_distro }}-ament-cppcheck ros-${{ inputs.ros_distro }}-ament-cpplint ros-${{ inputs.ros_distro }}-ament-lint-cmake ros-${{ inputs.ros_distro }}-ament-copyright | ||
| source /opt/ros/${{ inputs.ros_distro }}/setup.bash | ||
| python -m pip install pre-commit | ||
| pre-commit run --show-diff-on-failure --color=always --all-files --hook-stage manual | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -31,8 +31,6 @@ jobs: | |
| env: | ||
| # this will be src/{repo-owner}/{repo-name} | ||
| path: src/${{ github.repository }} | ||
| steps: | ||
| - uses: ros-tooling/[email protected] | ||
| with: | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| name: Update pre-commit | ||
| # Update pre-commit config and create PR if changes are detected | ||
| # author: Christoph Fröhlich <[email protected]> | ||
|
|
||
| on: | ||
| workflow_call: | ||
|
|
||
| jobs: | ||
| auto_update_and_create_pr: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Install pre-commit | ||
| run: | | ||
| pip install pre-commit | ||
|
|
||
| - name: Auto-update with pre-commit | ||
| run: | | ||
| pre-commit autoupdate || true # Ignoring errors | ||
|
|
||
| - name: Check for changes | ||
| id: git_status | ||
| run: | | ||
| git diff --quiet && echo "::set-output name=changed::false" || echo "::set-output name=changed::true" | ||
|
|
||
| - name: There are changes | ||
| if: steps.git_status.outputs.changed == 'true' | ||
| run: | | ||
| echo "Files have changed" | ||
| git diff --exit-code || true | ||
|
|
||
| - name: No changes! | ||
| if: steps.git_status.outputs.changed == 'false' | ||
| run: | | ||
| echo "No changes detected" | ||
|
|
||
| - name: Create Pull Request | ||
| if: steps.git_status.outputs.changed == 'true' | ||
| uses: peter-evans/create-pull-request@v6 | ||
|
There was a problem hiding this comment. Would we want to specify the author here, as well? Otherwise, the default author Defaults to the user who triggered the workflow run which might be misleading in some situations. There was a problem hiding this comment. There was a problem hiding this comment. I'd test this first without specifying it, because in the demos of the action the PR is also from the github action bot without having specified it.. let's see ;) |
||
| with: | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
| branch: auto-update | ||
| commit-message: Auto-update with pre-commit | ||
| title: Bump version of pre-commit hooks | ||
| body: This pull request contains auto-updated files of pre-commit config. | ||
| delete-branch: true | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| name: Auto Update pre-commit | ||
| # Update pre-commit config and create PR if changes are detected | ||
| # author: Christoph Fröhlich <[email protected]> | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| schedule: | ||
| - cron: '0 0 * * 0' # Run every Sunday at midnight | ||
|
|
||
| jobs: | ||
| auto_update_and_create_pr: | ||
| uses: ./.github/workflows/reusable-update-pre-commit.yml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will probably get problematic on 24.04, since python 3.11 doesn't allow to install pip packages without a venv by default (see e.g. https://stackoverflow.com/questions/75602063/pip-install-r-requirements-txt-is-failing-this-environment-is-externally-mana). We can keep that in mind for later, though...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For me it seemed that every step has its own vritual environment? this is why https://github.com/pre-commit/action/blob/main/action.yml#L13 didn't show any of the ROS packages before?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, the hooks use their own venv (if they are python hooks). However,
pre-commititself is installed without a venv here. I am simply referring to thepython -m pip install pre-commitcommand. This will not work on 24.04 (without any modifications to the systemat least). One way to resolve this (Doing this on my 23.10 machine for instance) would be to installpipx (available in apt)and then dopipx install pre-commit && pipx ensurepathThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
then we will have more problems, for example also with the sphinx build I guess
https://github.com/ros-controls/control.ros.org/blob/51ff1372c4014845b4b3b7f9fd86644d05fa1db3/.github/workflows/sphinx-make-page.yml#L22-L32
let's keep it like this for now and remember it until rolling is targeting on 24.04 (which might be together with Jazzy release?)