Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 41 additions & 3 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ on:
release:
types: [published]
jobs:
build-documentation:
build_documentation:
runs-on: ubuntu-latest
steps:
- name: Checkout
Expand All @@ -15,5 +15,43 @@ jobs:
architecture: 'x64'
- name: Install dependencies
run: python -m pip install --upgrade pip mkdocs mkdocs-material
- name: Deploy documentation
run: mkdocs gh-deploy --force
- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
name: docs-artifact
path: _site/
build_api:
needs: build_documentation
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup PHP, with composer and extensions
uses: shivammathur/setup-php@v2
with:
php-version: '8.3'
coverage: none
- name: Install composer dependencies
uses: ramsey/composer-install@v3
with:
composer-options: "--prefer-dist --optimize-autoloader"
- name: Download phpDocumentor phar archive
run: wget https://phpdoc.org/phpDocumentor.phar
- name: Build the coumentation api
run: php phpDocumentor.phar
- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
name: api-artifact
path: _site/api/
deploy_documentation:
needs: [build_documentation,build_api]
runs-on: ubuntu-latest
steps:
- name: Download artifacts
uses: actions/download-artifact@v4
- name: Deploy documentation to Github Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./_site
4 changes: 3 additions & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
fail-fast: false
matrix:
operating-system: [ubuntu-latest, windows-latest, macOS-latest]
php-versions: ['8.2', '8.3']
php-versions: ['8.3', '8.4']
symfony-version: ['6.4', '7.1']
runs-on: ${{ matrix.operating-system }}
steps:
Expand All @@ -32,8 +32,10 @@ jobs:
with:
composer-options: "--prefer-dist --optimize-autoloader"
- name: Check coding standard
if: matrix.php-versions != '8.4'
run: composer cs:check
- name: Static analysis tool
if: matrix.php-versions != '8.4'
run: composer analytics
- name: Test suite
run: composer test
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ composer.phar
composer.lock
coverage/
vendor/
_site/
23 changes: 23 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,29 @@ All notable changes to `susina/config-builder` project will be documented in thi
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

### [1.1] - 2025-05-22
### Added
- Add `replaces` option to inject an external parameter to resolve. Useful, i.e. to pass
`kernel_dir` or other parameters.
- Add [phpdocumentor](https://phpdoc.org/) to generate the documentation api
### Changed
- Update the documentation

## [1.0.1] - 2024-11-30
### Fixed
- Remove PHP 8.4 deprecations

## [1.0] - 2024-09-16
### Added
- Introduce `susina/param-resolver` library
- Introduce `susina/xml-to-array` library
### Changed
- Bump dependencies
- Update Github Actions
- Update documentation
### Removed
- Remove `.ini` support since it's not suited for complex nested configurations

## [0.4] - 2023-02-16
### Added
- `ConfigBuilder::keepFirstXmlTag` method, to include into the configuration array also the first xml tag
Expand Down
261 changes: 0 additions & 261 deletions docs/methods.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ $builder = ConfigurationBuilder::create()
;
```

You can set up the `ConfigurationBuilder` via all the methods explained into [Api Reference](methods.md) document.
You can set up the `ConfigurationBuilder` via all the methods explained into [Api Reference](api/index.html) document.

## Get The Configuration as an Array

Expand Down
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ edit_uri: ''
copyright: 'Susina Configuration Builder is licensed under <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache 2.0 license</a>'

#Configuration
site_dir: _site
theme:
name: material
favicon: assets/hammer-and-wrench.png
Expand All @@ -28,7 +29,7 @@ nav:
- Installation: installation.md
- Usage: usage.md
- Reference:
- Api: methods.md
- Api: api/index.html
- Parameters reference: parameters.md
- Complete Example: example.md
- About:
Expand Down
Loading