Skip to content

Commit

Permalink
chore: fix readme formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
lotyp committed Mar 28, 2024
1 parent d5b7afa commit 5a06011
Showing 1 changed file with 10 additions and 12 deletions.
22 changes: 10 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Read more about [reusing workflows](https://docs.github.com/en/actions/using-wor

### → Auto Label and Release Management

#### `apply-labels.yml:`
#### `apply-labels.yml:`

Automatically applies labels to pull requests based on modified paths.

Expand Down Expand Up @@ -84,7 +84,7 @@ jobs:

<br>

### `auto-merge-release.yml:`
#### `auto-merge-release.yml:`

This workflow automatically merges releases. This workflow utilizes [peter-evans/enable-pull-request-automerge](https://github.com/peter-evans/enable-pull-request-automerge) to auto-merge releases that are created by [googleapis/release-please](https://github.com/googleapis/release-please).

Expand Down Expand Up @@ -119,7 +119,7 @@ jobs:

<br>

### `create-release.yml:`
#### `create-release.yml:`

This workflow uses [google-github-actions/release-please-action](https://github.com/google-github-actions/release-please-action) to create automated releases based on [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/).

Expand Down Expand Up @@ -152,7 +152,7 @@ jobs:

### → Docker

### `build-image.yml:`
#### `build-image.yml:`

This workflow builds a docker image and pushes it to the GitHub Container Registry.

Expand Down Expand Up @@ -267,7 +267,7 @@ jobs:

### → Create Diagrams

### `create-arch-diagram.yml:`
#### `create-arch-diagram.yml:`

This workflow leverages the [codesee-io/codesee-action](https://github.com/Codesee-io/codesee-action) action to automatically generate architecture diagrams for your codebase whenever a pull request is made.

Expand Down Expand Up @@ -308,7 +308,7 @@ jobs:

### → Static Analysis

### `shellcheck.yml:`
#### `shellcheck.yml:`

This workflow uses [redhat-plumbers-in-action/differential-shellcheck](https://github.com/redhat-plumbers-in-action/differential-shellcheck) to run shell script analysis.

Expand Down Expand Up @@ -345,7 +345,7 @@ Composite Actions are a powerful feature of GitHub Actions that allow you to cre

### → Dependency Management

### `composer/install:`
#### `composer/install:`

This action installs dependencies with Composer based on the specified dependency level (`lowest`, `locked`, `highest`). It's designed to be flexible, allowing you to specify the working directory for the Composer command.

Expand Down Expand Up @@ -387,7 +387,7 @@ jobs:
<br>
### `composer/get-cache-directory:`
#### `composer/get-cache-directory:`

This action determines the Composer cache directory and exports it as `COMPOSER_CACHE_DIR` environment variable. It allows you to specify the working directory for the Composer command to determine the cache directory.

Expand Down Expand Up @@ -420,7 +420,7 @@ jobs:

<br>

### `composer/get-root-version:`
#### `composer/get-root-version:`

This action determines the Composer root version based on the specified branch and exports it as `COMPOSER_ROOT_VERSION` environment variable. It's designed to be flexible, allowing you to specify both the branch and the working directory for the Composer command to determine the root version.

Expand Down Expand Up @@ -452,9 +452,7 @@ jobs:
working-directory: '.'
```

These sections are designed to seamlessly integrate with your existing `README.md` documentation, providing clear instructions on how to use the new Composer actions within GitHub workflows.


<br>

## 🤝 License

Expand Down

0 comments on commit 5a06011

Please sign in to comment.