Skip to content

Commit

Permalink
Update DOC, and add github actions
Browse files Browse the repository at this point in the history
  • Loading branch information
Yurujai committed Feb 6, 2024
1 parent 8b0dba9 commit 8cdae38
Show file tree
Hide file tree
Showing 4 changed files with 54 additions and 3 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Code validation

on: [push, pull_request]

jobs:
build:
runs-on: ubuntu-latest
strategy:
fail-fast: true
matrix:
php-versions: ['7.2']

steps:
- name: Checkout
uses: actions/checkout@v2

- name: PHP validator
run: find . -type f -name "*.php" -print0 | xargs -0 -n1 -P8 php -l

- name: PHPCSFixer
uses: docker://oskarstark/php-cs-fixer-ga:3.1.0
with:
args: --config=.php-cs-fixer.dist.php --diff --dry-run
24 changes: 24 additions & 0 deletions .php-cs-fixer.dist.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<?php
$finder = PhpCsFixer\Finder::create()
->in(__DIR__)
->exclude('var')
;

$config = new PhpCsFixer\Config();
return $config->setRules([
'@Symfony' => true,
'@PhpCsFixer' => true,
'array_syntax' => ['syntax' => 'short'],
'is_null' => true,
'list_syntax' => ['syntax' => 'short'],
'modernize_types_casting' => true,
'ternary_to_null_coalescing' => true,
'combine_nested_dirname' => true,
'phpdoc_types_order' => [
'null_adjustment' => 'always_last',
'sort_algorithm' => 'none',
],
])
->setFinder($finder)
->setRiskyAllowed(true)
;
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
ExternalAPIBundle
=================

WARNING: We cannot guarantee that this module is compatible with new versions of PuMuKIT.

This package allow to interact with PuMuKIT through an external API. It is a RESTful API that allows to create and update Multimedia Objects.

API Examples using curl:

##### New mediapackage
##### New media package
```
curl -X POST -f -i --basic -u admin:admin http://localhost:8000/app_dev.php/api/ingest/createMediaPackage
```
Expand Down
4 changes: 2 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@
"bundle",
"pumukit"
],
"homepage": "https://gitlab.teltek.es/pumukit/PumukitExternalAPIBundle.git",
"homepage": "https://github.com/teltek/PumukitExternalAPIBundle.git",
"license": "proprietary",
"authors": [
{
"name": "Teltek Team",
"homepage": "http://teltek.es"
"homepage": "https://teltek.es"
}
],
"require": {
Expand Down

0 comments on commit 8cdae38

Please sign in to comment.