Skip to content

Commit

Permalink
Fix: Document all side effects
Browse files Browse the repository at this point in the history
  • Loading branch information
localheinz committed Dec 16, 2023
1 parent fabb456 commit b7e7279
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 34 deletions.
3 changes: 3 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
indent_size = 2

[*.{yaml,yml}]
indent_size = 2

Expand Down
64 changes: 30 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,17 +131,17 @@ none

#### Side Effects

The `COMPOSER_ROOT_VERSION` environment variable contains the root version if it has been defined as `branch-alias` in `composer.json`.

```json
{
"extra": {
"branch-alias": {
"dev-main": "10.0-dev"
- The `COMPOSER_ROOT_VERSION` environment variable contains the root version if it has been defined as `branch-alias` in `composer.json`.

```json
{
"extra": {
"branch-alias": {
"dev-main": "10.0-dev"
}
}
}
}
```
```

### <a name="composer-install"> `ergebnis/.github/actions/composer/install`

Expand Down Expand Up @@ -208,22 +208,22 @@ none

#### Side Effects

When `dependencies` is set to `"lowest"`, dependencies are installed in the directory specified by `working-directory` with
- When `dependencies` is set to `"lowest"`, dependencies are installed in the directory specified by `working-directory` with

```shell
composer update --ansi --no-interaction --no-progress --prefer-lowest
````
When `dependencies` is set to `"locked"`, dependencies are installed in the directory specified by `working-directory` with
```shell
composer update --ansi --no-interaction --no-progress --prefer-lowest
````
- When `dependencies` is set to `"locked"`, dependencies are installed in the directory specified by `working-directory` with

```shell
composer install --ansi --no-interaction --no-progress
```
```shell
composer install --ansi --no-interaction --no-progress
```

When `dependencies` is set to `"highest"`, dependencies are installed in the directory specified by `working-directory` with
- When `dependencies` is set to `"highest"`, dependencies are installed in the directory specified by `working-directory` with

```shell
composer update --ansi --no-interaction --no-progress
````
```shell
composer update --ansi --no-interaction --no-progress
````
### <a name="github-pull-request-add-assignee"> `ergebnis/.github/actions/github/pull-request/add-assignee`

Expand Down Expand Up @@ -276,7 +276,7 @@ none

#### Side Effects

The GitHub user with the username specified in the `assignee` input is assigned to the pull request.
- The GitHub user with the username specified in the `assignee` input is assigned to the pull request.

### <a name="github-pull-request-add-label-based-on-branch-name"> `ergebnis/.github/actions/github/pull-request/add-label-based-on-branch-name`

Expand Down Expand Up @@ -369,7 +369,7 @@ none

#### Side Effects

The pull request is approved by the user who owns the GitHub token specified with the `github-token` input.
- The pull request is approved by the user who owns the GitHub token specified with the `github-token` input.

### <a name="github-pull-request-merge"> `ergebnis/.github/actions/github/pull-request/merge`

Expand Down Expand Up @@ -421,7 +421,7 @@ none

#### Side Effects

The pull request is merged by the user who owns the GitHub token specified with the `github-token` input.
- The pull request is merged by the user who owns the GitHub token specified with the `github-token` input.

### <a name="github-pull-request-request-review"> `ergebnis/.github/actions/github/pull-request/request-review`

Expand Down Expand Up @@ -474,7 +474,7 @@ none

#### Side Effects

A pull request review is requested for the user identified by the value of the `reviewer` input by the user who owns the GitHub token specified with the `github-token` input.
- A pull request review is requested for the user identified by the value of the `reviewer` input by the user who owns the GitHub token specified with the `github-token` input.

### <a name="github-release-create"> `ergebnis/.github/actions/github/release/create`

Expand Down Expand Up @@ -516,7 +516,7 @@ none

#### Side Effects

A release is created by the user who owns the GitHub token specified with the `github-token` input.
- A release is created by the user who owns the GitHub token specified with the `github-token` input.

### <a name="oh-dear-check-request-run"> `ergebnis/.github/actions/oh-dear/check/request-run`

Expand Down Expand Up @@ -562,7 +562,7 @@ none

#### Side Effects

A check run is requested by the user who owns the Oh Dear API token specified with the `oh-dear-api-token` input for the check identified by the `oh-dear-check-id` input.
- A check run is requested by the user who owns the Oh Dear API token specified with the `oh-dear-api-token` input for the check identified by the `oh-dear-check-id` input.

### <a name="oh-dear-maintenance-period-start"> `ergebnis/.github/actions/oh-dear/maintenance-period/start`

Expand Down Expand Up @@ -608,7 +608,7 @@ none

#### Side Effects

A maintenance period is started by the user who owns the Oh Dear API token specified with the `oh-dear-api-token` input for the site identified by the `oh-dear-site-id` input.
- A maintenance period is started by the user who owns the Oh Dear API token specified with the `oh-dear-api-token` input for the site identified by the `oh-dear-site-id` input.

### <a name="oh-dear-maintenance-period-stop"> `ergebnis/.github/actions/oh-dear/maintenance-period/stop`

Expand Down Expand Up @@ -654,7 +654,7 @@ none

#### Side Effects

A maintenance period is stopped by the user who owns the Oh Dear API token specified with the `oh-dear-api-token` input for the site identified by the `oh-dear-site-id` input.
- A maintenance period is stopped by the user who owns the Oh Dear API token specified with the `oh-dear-api-token` input for the site identified by the `oh-dear-site-id` input.

### <a name="phive-install"> `ergebnis/.github/actions/phive/install`

Expand Down Expand Up @@ -705,11 +705,7 @@ none

#### Side Effects

Dependencies are installed, assuming

- `phive` is available
- `phive` could find a `phars.xml`
- keys presented by packages are listed using the `trust-gpg-keys` option
- Given that `phive` is available, `phive` could find a `phars.xml`, and keys presented by packages are listed using the `trust-gpg-keys` option, dependencies are installed with `phive`.

The directory configured by the `phive-home` directory is cached using [`actions/cache`](https://github.com/actions/cache).

Expand Down

0 comments on commit b7e7279

Please sign in to comment.