In your GitHub workflow file (usually located in .github/workflows/), you can add the artefacts-ci action to a job. Here's an example:
jobs:
artefacts-ci:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: art-e-fact/action-artefacts-ci@main
with:
artefacts-api-key: ${{ secrets.ARTEFACTS_API_KEY }}
job-name: basic_tests
In this example, replace basic_tests with the name of your job that you already have in your artefacts.yaml file.
Optionally, you can add a ros test job before the artefacts-ci to ensure everything is working before running the platform job:
jobs:
ros2-test:
runs-on: ubuntu-latest
env:
ROS_DISTRO: humble
steps:
- uses: actions/checkout@v3
- uses: ros-tooling/[email protected]
with:
required-ros-distributions: ${{ env.ROS_DISTRO }}
- uses: ros-tooling/[email protected]
with:
import-token: ${{ secrets.GITHUB_TOKEN }}
package-name: dolly_tests
target-ros2-distro: ${{ env.ROS_DISTRO }}
skip-tests: true
artefacts-ci:
needs: ros2-test
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: art-e-fact/action-artefacts-ci@main
with:
artefacts-api-key: ${{ secrets.ARTEFACTS_API_KEY }}
job-name: basic_tests
# If you prefer a custom name in the platform instead of the commit.
# description: "Custom name"
The artefacts-api-key input requires a secret. In your GitHub repository, go to "Settings" -> "Secrets" and add a new secret named ARTEFACTS_API_KEY with your Artefacts API key as the value.
Once you've set up the workflow and the secret, you can run the workflow by making a commit to the branch where the workflow file is located.
You can also add a badge to your README to show the status of your last platform job. Replace dolly-demo with the name of your project and job name:
[](https://app.artefacts.com/dolly-demo/tests)
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent