Skip to content

Commit e26d909

Browse files
committed
docs: update README to use action from root
1 parent 5ee8c9d commit e26d909

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,12 @@
1-
# GFModules Trigger CI
1+
# GFModules Trigger CI GitHub Action
22

3-
- This pipeline is designed to trigger a TI (test integration) workflow for a GFModules project.
4-
It will trigger the workflow and pass the necessary parameters.
5-
- The pipeline is designed to be as generic as possible, so they can be easily reused in any project.
6-
- This repository is a part of the generic GitHub Actions pipeline collection that can be used in any project.
3+
This repository provides a reusable GitHub Action for triggering a TI (test integration) workflow for a GFModules project. It will trigger the workflow and pass the necessary parameters.
74

85
## Usage
96

10-
Here is a basic example of how you can integrate it in your project.
11-
12-
<details>
13-
<summary>Example workflow</summary>
7+
To use the action, add it to a workflow in your repository:
148

15-
This workflow is executed automatically on push to the main branch, except for dependabot merges.
9+
Here is a basic example of how you can integrate it in your project.
1610

1711
```yml
1812
name: GFModules Trigger CI
@@ -29,20 +23,22 @@ jobs:
2923
runs-on: ubuntu-latest
3024
steps:
3125
- name: Trigger CI
32-
uses: minvws/gfmodules-action-trigger-ci/.github/actions/gfmodules-trigger-ci@main
26+
uses: minvws/gfmodules-action-trigger-ci@v1
3327
with:
34-
orac_htpasswd: ${{secrets.ORAC_HTPASSWD}}
35-
endpoint_url: ${{URL}}
28+
orac_htpasswd: ${{ secrets.ORAC_HTPASSWD }}
29+
endpoint_url: <url>
3630
```
3731
38-
</details>
32+
Replace `<url>` with the URL of the ORAC endpoint.
33+
34+
In this basic example, the workflow is executed automatically on push to the `main` branch and on any pull request. And thanks to the `workflow_dispatch` trigger it can also be executed manually from the repository's Actions tab.
3935

4036
### Configuration
4137

42-
The action has inputs. The inputs are:
38+
The action has the following inputs:
4339

44-
- orac_htpasswd: The HTPassword for the ORAC endpoint. This is a secret and should be stored in the repository secrets. It should be in the format of `user:pass`.
45-
- endpoint_url: The URL of the ORAC endpoint. This is a required input and should be provided as a string.
40+
- `orac_htpasswd` (**required**): The HTPassword for the ORAC endpoint, formatted as `"user:pass"`. This should be stored in the repository secrets.
41+
- `endpoint_url` (**required**): The URL of the ORAC endpoint.
4642

4743
### Update the bundle
4844

@@ -52,3 +48,7 @@ When making changes in the src/index.js, make sure you generate the bundle by ru
5248

5349
If you want to contribute a new pipeline, please check the reusable workflow guidelines in the
5450
[GitHub documentation](https://docs.github.com/en/actions/using-workflows/reusing-workflows#creating-a-reusable-workflow).
51+
52+
## License
53+
54+
This repository is released under the EUPL 1.2 license. See [LICENSE](./LICENSE) for details.

0 commit comments

Comments
 (0)