Merge branch 'github-release-workflow' into 'master'

Add GH release workflow See merge request plugins/prestashop!19
tpay-com · Mar 25, 2024 · 3c032b7 · 3c032b7
2 parents 1ed2d75 + 738768d
commit 3c032b7
Show file tree

Hide file tree

Showing 4 changed files with 149 additions and 40 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -0,0 +1,48 @@
+name: Continuous integration
+
+on:
+  pull_request:
+  push:
+
+jobs:
+  check:
+    name: PHP ${{ matrix.php-version }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - php-version: '7.1'
+          - php-version: '7.2'
+          - php-version: '7.3'
+          - php-version: '7.4'
+          - php-version: '8.0'
+          - php-version: '8.1'
+          - php-version: '8.2'
+          - php-version: '8.3'
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          extensions: none, curl, json, mbstring
+          coverage: none
+
+      - id: composer-cache
+        shell: bash
+        run: echo "dir=$(composer config cache-dir)" >> $GITHUB_OUTPUT
+
+      - uses: actions/cache@v3
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+
+      - run: mkdir dev-tools
+
+      - working-directory: dev-tools
+        run: composer require php-parallel-lint/php-parallel-lint
+
+      - working-directory: dev-tools
+        run: ./vendor/bin/parallel-lint ..
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -0,0 +1,22 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - '*'
+
+permissions:
+  contents: write
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - run: git archive --output=tpay-prestashop.zip HEAD --prefix=tpay/
+
+      - uses: softprops/action-gh-release@v1
+        with:
+          files: tpay-prestashop.zip
diff --git a/.github/workflows/sca.yaml b/.github/workflows/sca.yaml
@@ -0,0 +1,37 @@
+name: Static code analysis
+
+on:
+  pull_request:
+  push:
+
+jobs:
+  analyse:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.2
+          extensions: none, bcmath, curl, dom, fileinfo, gd, iconv, intl, mbstring, pdo_mysql, simplexml, soap, sockets, tokenizer, xsl, xmlwriter, zip
+          coverage: none
+
+      - run: composer validate --strict
+
+      - working-directory: .dev-tools
+        run: composer install
+
+      - working-directory: .dev-tools
+        run: composer normalize --diff --dry-run --indent-size=4 --indent-style=space ../composer.json
+
+      - working-directory: .dev-tools
+        run: composer cs:fixer -- --dry-run
+
+      - working-directory: .dev-tools
+        run: composer cs:sniffer
+
+      - working-directory: .dev-tools
+        run: composer cs:phpstan
+
+      - working-directory: .dev-tools
+        run: composer cs:psalm -- --no-progress --shepherd
diff --git a/README.MD b/README.MD
@@ -1,11 +1,47 @@
-# TPAY. INSTRUKCJA INSTALACJI MODUŁU PŁATNOŚCI
+# Tpay Prestashop Module
 
-## WYMAGANIA
+## Wymagania
 
-- Serwer PHP w wersji co najmniej 7.1
+- PHP w wersji co najmniej 7.1
 - PrestaShop w minimalnej wersji 1.7.7.5
 - Dostępna waluta PLN (dla przelewów bankowych online)**
 
+## Instalacja modułu
+
+1. Pobierz moduł na dysk twardy i zaloguj się do panelu administracyjnego Prestashop
+2. Przejdź do Sekcji Ulepszenia -> Moduły -> Menedżer modułów i wybierz opcję załaduj moduł
+3. Wybierz pobrany plik i zainstaluj
+
+## KONFIGURACJA MODUŁU
+
+### Główne ustawienia
+1. ID Klienta: Twój identyfikator sprzedawcy w systemie Tpay.com
+2. Sekretny Klucz - hasło do wygenerowanego klucza API
+3. Powiadomienia klucz bezpieczeństwa - Kod zabezpieczający jest dostępny w Panelu sprzedawcy w zakładce Ustawienia -> Powiadomienia -> bezpieczeństwo
+4. Użyj środowiska testowego
+5. Email dotyczączy powiadomień
+6. Dopłata za korzystanie z płatności - Tworzy produkt o określonej dopłacie która jest dodawana do zamówienia jako osobna pozycja
+    1. Rodzaj rozliczenia kwota, procent
+    2. Wartość dopłaty
+7. Widoczność kanałów płatności
+8. Inne ustawienia są opcjonalne i zależą od konkretnych wymagań
+   Kliknij przycisk Zapisz
+
+### Widoczność kanałów płatności
+- Wybierz kanały płatności które mają się wyświetlać na głównej liście
+
+### Karty kredytowe
+1. Pokaż karty kredytowe w głównym widoku listy płatności
+2. RSA key - Kod zabezpieczający jest dostępny w Panelu sprzedawcy w zakładce Płatności kartami -> API -> Klucz publiczny RSA
+
+
+### Statusy płatności
+1. Użyj statusów zdefiniowanych przez tpay
+2. Dostępne statusy dla płatności
+   - opłacona płatność
+   - oczekująca płatność
+   - niepoprawna niepoprawna
+
 ## DEVELOPER
 
 ### Wymagane
@@ -38,42 +74,6 @@ npm run watch # środowisko deweloperskie z podglądem zmian)
 npm run build # środowisko produkcyjne, minifikacja plików)
 ```
 
-## INSTALACJA MODUŁU
-
-- Pobierz moduł na dysk twardy i zaloguj się do panelu administracyjnego Prestashop
-- Przejdź do Sekcji Ulepszenia -> Moduły -> Menedżer modułów i wybierz opcję załaduj moduł
-- Wybierz pobrany plik i zainstaluj
-
-## KONFIGURACJA MODUŁU
-
-### Główne ustawienia
-1. ID Klienta: Twój identyfikator sprzedawcy w systemie Tpay.com
-2. Sekretny Klucz - hasło do wygenerowanego klucza API
-3. Powiadomienia klucz bezpieczeństwa - Kod zabezpieczający jest dostępny w Panelu sprzedawcy w zakładce Ustawienia -> Powiadomienia -> bezpieczeństwo
-4. Użyj środowiska testowego
-5. Email dotyczączy powiadomień
-6. Dopłata za korzystanie z płatności - Tworzy produkt o określonej dopłacie która jest dodawana do zamówienia jako osobna pozycja
-   1. Rodzaj rozliczenia kwota, procent
-   2. Wartość dopłaty
-7. Widoczność kanałów płatności 
-8. Inne ustawienia są opcjonalne i zależą od konkretnych wymagań
-    Kliknij przycisk Zapisz
-
-### Widoczność kanałów płatności
-- Wybierz kanały płatności które mają się wyświetlać na głównej liście
-
-### Karty kredytowe
-1. Pokaż karty kredytowe w głównym widoku listy płatności
-2. RSA key - Kod zabezpieczający jest dostępny w Panelu sprzedawcy w zakładce Płatności kartami -> API -> Klucz publiczny RSA
-
-
-### Statusy płatności
-1. Użyj statusów zdefiniowanych przez tpay
-2. Dostępne statusy dla płatności 
-- opłacona płatność
-- oczekująca płatność
-- niepoprawna niepoprawna
-
 ## Frontend
 
 ### Wymagania
@@ -93,4 +93,6 @@ npm run build # środowisko produkcyjne, minifikacja plików)
 
     ```shell
     npm run build
-    ```
+    ```
+
+## [Changelog](./CHANGELOG.md)