Skip to content

Commit

Permalink
refactoring dot-event and added documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Claudiu Pintiuta committed Apr 19, 2024
1 parent 6149b56 commit 39de14a
Show file tree
Hide file tree
Showing 17 changed files with 341 additions and 194 deletions.
11 changes: 11 additions & 0 deletions .github/workflows/continuous-integration.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: "Continuous Integration"

on:
pull_request:
push:
branches:
tags:

jobs:
ci:
uses: laminas/workflow-continuous-integration/.github/workflows/continuous-integration.yml@1.x
47 changes: 0 additions & 47 deletions .github/workflows/cs-tests.yml

This file was deleted.

16 changes: 16 additions & 0 deletions .github/workflows/docs-build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: docs-build

on:
release:
types: [published]
workflow_dispatch:

jobs:
build-deploy:
runs-on: ubuntu-latest
steps:
- name: Build Docs
uses: dotkernel/documentation-theme/github-actions/docs@main
env:
DEPLOY_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
47 changes: 0 additions & 47 deletions .github/workflows/static-analysis.yml

This file was deleted.

48 changes: 0 additions & 48 deletions .github/workflows/unit-tests.yml

This file was deleted.

4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ DotKernel event component extending and customizing [laminas-eventmanager](https
[![GitHub issues](https://img.shields.io/github/issues/dotkernel/dot-event)](https://github.com/dotkernel/dot-event/issues)
[![GitHub forks](https://img.shields.io/github/forks/dotkernel/dot-event)](https://github.com/dotkernel/dot-event/network)
[![GitHub stars](https://img.shields.io/github/stars/dotkernel/dot-event)](https://github.com/dotkernel/dot-event/stargazers)
[![GitHub license](https://img.shields.io/github/license/dotkernel/dot-event)](https://github.com/dotkernel/dot-event/blob/3.0/LICENSE.md)
[![GitHub license](https://img.shields.io/github/license/dotkernel/dot-event)](https://github.com/dotkernel/dot-event/blob/4.0/LICENSE.md)

[![Build Static](https://github.com/dotkernel/dot-event/actions/workflows/static-analysis.yml/badge.svg?branch=3.0)](https://github.com/dotkernel/dot-event/actions/workflows/static-analysis.yml)
[![Build Static](https://github.com/dotkernel/dot-event/actions/workflows/continuous-integration.yml/badge.svg?branch=4.0)](https://github.com/dotkernel/dot-event/actions/workflows/continuous-integration.yml)
[![codecov](https://codecov.io/gh/dotkernel/dot-event/graph/badge.svg?token=C00YQLVZ7Y)](https://codecov.io/gh/dotkernel/dot-event)

[![SymfonyInsight](https://insight.symfony.com/projects/5c4a19db-4114-4f92-a838-ea72ec4b9a5a/big.svg)](https://insight.symfony.com/projects/5c4a19db-4114-4f92-a838-ea72ec4b9a5a)
Empty file added docs/book/index.md
Empty file.
6 changes: 6 additions & 0 deletions docs/book/v4/configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Configuration

After installation, you need to register the `ConfigProvider` in your project
by adding the below line to your configuration aggregator (usually: `config/config.php`)

\Dot\Event\ConfigProvider
6 changes: 6 additions & 0 deletions docs/book/v4/instalation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Instalation

Check failure on line 1 in docs/book/v4/instalation.md

View workflow job for this annotation

GitHub Actions / ci / QA Checks (Documentation Linting [8.1, latest], ubuntu-latest, laminas/laminas-continuous-integra...

Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "# Instalation"]
Install `dot-event` by executing the following composer command

```bash
composer require dotkernel/dot-event
```
3 changes: 3 additions & 0 deletions docs/book/v4/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Overview

Check failure on line 1 in docs/book/v4/overview.md

View workflow job for this annotation

GitHub Actions / ci / QA Checks (Documentation Linting [8.1, latest], ubuntu-latest, laminas/laminas-continuous-integra...

Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "# Overview"]
Dotkernel's event manager is extending [laminas-eventmanager](https://docs.laminas.dev/laminas-eventmanager/)
so it can be easier to implement events and listeners.

0 comments on commit 39de14a

Please sign in to comment.