GitHub meta repository for sbgisen.
The workflow can check the following items automatically.
- C++
- Format (clang-format)
- Python
- Format (autopep8)
- Lint (flake8)
- Cmake
- Format (cmake-format)
- Yaml
- Lint (yamllint)
- XML (launch files, package.xml, xacro files, urdf files)
- Format (xmllint)
- Lint (xmllint)
- Only launch files and package.xml
-
inputs.python_version (Optional)
Use to lint python code. Default is
3.8
.
-
Create a GitHub actions workflow file in your repository. e.g.
[repository_root]/.github/workflows/[your_workflow_name].yml
-
Just add
uses
as in the example file.You should set trigger to
on: [pull_request]
. Because the workflow suggest format and comment lint error with Pull Request review API.
name: [your_workflow_name]
on: [pull_request]
jobs:
linter_for_ROS_packages:
name: Linter for ROS packages
uses: sbgisen/.github/.github/workflows/linter_ros_package.yaml@main
This repository contains Release Drafter config file.
.github/release-drafter.yml
You can call workflow, with the following:
uses: sbgisen/.github/.github/workflows/release-drafter.yml@main
ros-build.yml
can be verified that the build of the ROS package located in the repository passes.
-
secrets.ssh_key
Use to execute
wstool
. Set private SSH key to secrets on the repository/organization. -
secrets.known_hosts
Use to execute
wstool
. Set the result ofssh-keyscan github.com
to secrets on the repository/organization. -
inputs.package_name (Optional)
ROS package name. Default is
github.event.repository.name
. -
inputs.install_libfreenect2 (Optional)
Whether the workflow install libfreenect2. Default is
false
. -
inputs.run_test (Optional)
Whether the workflow run rostest. Default is
false
. -
inputs.runs_on (Optional)
Select environment. Default is
ubuntu-latest
. To use self hosted runner, set tags to this parameter such as[self-hosted, lab]
-
inputs.setup_script (Optional)
Setup script filename. Default is empty. To install/setup dependencies not supported by
wstool
orrosdep
. -
inputs.ignore_rosinstalls (Optional)
Specify relative paths from
/path/to/workspace/src
as in./ros-package/.rosinstall
, separated by commas. Default is./eband_local_planner/.travis.rosinstall
.
You can call workflow, with the following:
jobs:
Build_ROS_package:
name: Build ROS package
uses: sbgisen/.github/.github/workflows/ros-build.yml@main
secrets:
ssh_key: ${{ secrets.SSH_KEY }}
known_hosts: ${{ secrets.KNOWN_HOSTS }}
with:
install_libfreenect2: false
run_test: false
runs_on: ubuntu-latest
ros-test.yml
can run ros test.
-
inputs.package_name (Optional)
ROS package name. Default is
github.event.repository.name
. -
inputs.install_libfreenect2 (Optional)
Whether the workflow install libfreenect2. Default is
false
. -
inputs.setup_script (Optional)
Setup script filename. Default is empty. To install/setup dependencies not supported by
wstool
orrosdep
. -
inputs.ignore_rosinstalls (Optional)
Specify relative paths from
/path/to/workspace/src
as in./ros-package/.rosinstall
, separated by commas. Default is./eband_local_planner/.travis.rosinstall
.
- Please add self-hosted-runner to the repository/organization to use this job.
- The job is run on the self hosted server with
self-hosted
andlab
labels.
- The job is run on the self hosted server with
- You can call workflow, with the following:
jobs:
Run_ROS_test:
name: Run ROS test
uses: sbgisen/.github/.github/workflows/ros-test.yml@main
with:
install_libfreenect2: false
pr-agent.yml
can be used to automatically write descriptions of PRs, review PRs, improve comments, and so on.
-
inputs.common_extra_instructions
Common extra instructions for all commands. It will be used if the specific instructions are not provided. Default is empty.
-
inputs.description_extra_instructions
Description extra instructions. Default is empty.
-
inputs.review_extra_instructions
Review extra instructions. Default is empty.
-
inputs.improve_extra_instructions
Improve extra instructions. Default is empty.
-
secrets.openai_key
Use to call OpenAI API. Set OpenAI API key to secrets on the repository/organization.
- Create a GitHub actions workflow file in your repository. e.g.
[repository_root]/.github/workflows/[your_workflow_name].yml
- Just add
uses
as in the example file.
If you want to automatically comment on PRs created by PR agent when a PR is created, specify opened
in pull_request
.
synchronize
and reopened
will cause PR agent to run when you add a commit to a PR, etc., consuming a large number of tokens.
If you don't need to run PR agent automatically on all PRs, but only when you post /describe
(or /review
, /improve
...) in a comment, specify created
(or edited
) in issue_comment
.
If you want to generate content in Japanese, you can specify Please answer in Japanese.
in **_extra_instructions
.
name: [your_workflow_name]
on:
# For automatically comment on PRs created by PR agent when a PR is created
pull_request:
types: [opened]
# For run PR agent only when you post command in a comment
issue_comment:
types: [created, edited]
jobs:
PR_agent:
name: PR agent
uses: sbgisen/.github/.github/workflows/pr_agent.yml@main
with:
common_extra_instructions: "Please answer in Japanese." # Optional
secrets:
openai_key: ${{ secrets.OPENAI_KEY }}