Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Updated documentation to better describe event triggers for workflows.
  • Loading branch information
wener-tiobe authored Aug 14, 2024
1 parent 6926a3b commit a5a8da1
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ There are two types of analysis modes available:
### Supported Platforms
Linux and Windows based runners, both GitHub-hosted and self-hosted, are supported.


### Action Restrictions
- It is not working for forked repositories.
- It is not working for TICS installations using the legacy deployment architecture.
Expand Down Expand Up @@ -52,6 +51,11 @@ jobs:
installTics: true
```
### Action triggers and events
The most common use case to trigger a workflow running TICS Client is typically on `pull_request`. Depending on the applied way of working, other events may be also applicable.
Please consult Github documentation for [triggering a workflow](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/triggering-a-workflow#using-a-single-event) and
[events that trigger workflows](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows) for more information.

### Basic parameters
The following inputs are recommended or required for this action:

Expand Down Expand Up @@ -86,7 +90,11 @@ With TICSQServer, persistent measurement points are created which are stored in
TICSQServer can also compare the last obtained results with the previous run and apply Quality Gating.

```yaml
on: [pull_request]
on:
push:
branches:
- main
- 'releases/**'
jobs:
TICS:
Expand All @@ -104,6 +112,11 @@ jobs:
installTics: true
```

### Action triggers and events
The most common use case to trigger a workflow running TICSQServer is typically on `push` to `main`, or any other branch from which other branches are derived. Other examples are release and develop branches.
Please consult Github documentation for [triggering a workflow](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/triggering-a-workflow#using-a-single-event) and
[events that trigger workflows](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows) for more information.

### Basic parameters
The following inputs are recommended or required for this action:

Expand Down Expand Up @@ -156,7 +169,7 @@ Below, parameters are described to control infra structure and security related
There is also the possibility to do a so called "diagnostic" run. This mode can be enabled to test if TICS has been set up properly and can run on the machine the action is run on.

```yaml
on: [pull_request]
on: workflow_dispatch
jobs:
TICS:
Expand All @@ -171,6 +184,11 @@ jobs:
ticsAuthToken: ${{ secrets.TICSAUTHTOKEN }}
installTics: true
```
### Action triggers and events
The most common use case to trigger the diagnostic workflow is typically on `workflow_dispatch`. This way one can manually execute this.
Please consult Github documentation for [triggering a workflow](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/triggering-a-workflow#using-a-single-event) and
[events that trigger workflows](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows) for more information.

#### Basic parameters
The following inputs are recommended or required for this action:

Expand Down

0 comments on commit a5a8da1

Please sign in to comment.