github-actions/galaxy-import-role
github-actions/galaxy-import-role
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

feat(readme): improve readme for new release

Browse Source
This commit is contained in:
Bertrand Lanson 2024-02-05 19:59:42 +01:00
parent 154a551f3d
commit c272936860
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -8,8 +8,10 @@ This action imports the repository as an ansible-galaxy role
The following parameters can be used as `step.with` keys: The following parameters can be used as `step.with` keys:
| Name | Type | Default | Required |Description | | Name | Type | Default | Required |Description |
| ---------------- | ------ | ------- |--------- |---------------------- | | ------------------ | ------ | ------- |--------- |------------------------ |
| `galaxy-api-key` | String | | yes | Ansible Galaxy API-key | | `galaxy-api-key` | String | | yes | Ansible Galaxy API-key |
| `repository-owner` | String | | yes | GitHub Repository Owner |
| `repository-name` | String | | yes | GitHub Repository Name |
## Example usage ## Example usage
@ -23,4 +25,6 @@ jobs:
uses: ednxzu/action-galaxy-role-import@v1 uses: ednxzu/action-galaxy-role-import@v1
with: with:
galaxy-api-key: ${{ secrets.galaxy_api_key }} galaxy-api-key: ${{ secrets.galaxy_api_key }}
repository-owner: <github_owner_name>
repository-name: <github_repository_name>
``` ```