Release updater (#4)

* feat: add updater

* fix: uninstallable dependency on PHP > 8

* chore: release 3.1.0

* fix: redundant whitespace

Author: sanderdekroon

.github/workflows/release.yml

@@ -0,0 +1,24 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: php-actions/composer@v6
+        with:
+          # Lowest supported PHP version
+          php_version: "7.4"
+      - run: composer run package
+      - name: Release
+        uses: fnkr/github-action-ghr@v1
+        env:
+          GHR_COMPRESS: zip
+          GHR_PATH: releases/
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -35,6 +35,7 @@
 
 # track this file .gitignore (i.e. do NOT ignore it)
 !.gitignore
+!.github/
 
 # Eslint
 !.eslintrc
@@ -91,6 +92,7 @@ bower_components
 *.map
 
 vendor
+releases
 !/src/vendor
 
-tests/coverage
+tests/coverage

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 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).
 
+## Version [3.1.0]
+
+### Feat
+
+-   Updates can now be provided through the Admin interface
+
 ## [3.0.5] - 2023-03-10
 
 ### Added

README.md

@@ -1,12 +1,29 @@
-# README #
+# README
 
 This README documents whatever steps are necessary to get this plugin up and running.
 
-### How do I get set up? ###
+### How do I get set up?
      
 * Unzip and/or move all files to the /wp-content/plugins/pdc-faq directory
 * Log into WordPress admin and activate the ‘PDC FAQ’ plugin through the ‘Plugins’ menu
 
+## Getting started
+### Installation
+
+#### For users
+1. Download the latest release from [the releases page](https://github.com/OpenWebconcept/plugin-pdc-faq/releases)
+2. Unzip and move all files to the `/wp-content/plugins/pdc-faq` directory.
+3. Log into the WordPress admin and activate the 'PDC FAQ' plugin through the 'plugins' menu
+
+#### For developers
+To contribute to this project, no dependencies are required. However, you will need to download [Composer](https://getcomposer.org/) to run tests or create an optimized build of the plugin.
+
+1. Clone this repository to your machine and/or WordPress installation
+2. Optionally use Composer (`composer install`) to install the dev dependencies
+
+To create an optimized and zipped build, run the `composer run package` command. This requires `Composer`, `rsync` and `zip` to run.
+
+
 ### Filters & Actions
 
 There are various [hooks](https://codex.wordpress.org/Plugin_API/Hooks), which allows for changing the output.
@@ -23,7 +40,7 @@ Via the plugin object the following config settings can be adjusted
 - rest_api_fields
 
 
-### Translations ###
+### Translations
 
 If you want to use your own set of labels/names/descriptions and so on you can do so. 
 All text output in this plugin is controlled via the gettext methods.
@@ -40,7 +57,7 @@ This plugin provides an easy interface for custom translations and a way to stor
 For instructions how to use the 'Loco Translate' plugin, we advice you to read the Beginners's guide page on their website: https://localise.biz/wordpress/plugin/beginners
 or start at the homepage: https://localise.biz/wordpress/plugin
 
-### Running tests ###
+### Running tests
 To run the Unit tests go to a command-line.
 ```bash
 cd /path/to/wordpress/htdocs/wp-content/plugins/pdc-faq/
@@ -53,13 +70,13 @@ For code coverage report, generate report with command line command and view res
 phpunit --coverage-html ./tests/coverage
 ```
 
-### Contribution guidelines ###
+### Contribution guidelines
 
 ##### Writing tests
 Have a look at the code coverage reports to see where more coverage can be obtained. 
 Write tests
 Create a Pull request to the OWC repository
 
-### Who do I talk to? ###
+### Who do I talk to?
 
 If you have questions about or suggestions for this plugin, please contact <a href="mailto:hpeters@Buren.nl">Holger Peters</a> from Gemeente Buren.

bin/package.sh

@@ -0,0 +1,31 @@
+#!/bin/bash
+
+## Remove old packages
+rm -rf ./releases
+mkdir -p ./releases
+
+# Copy current dir to tmp
+rsync \
+	-ua \
+	--exclude='vendor/*' \
+	--exclude='releases/*' \
+	./ ./releases/pdc-faq/
+
+# Remove current vendor folder (if any)
+# and install the dependencies without dev packages.
+cd ./releases/pdc-faq || exit
+composer install -o --no-dev
+
+# Remove unneeded files in a WordPress plugin
+rm -rf ./.git ./composer.json ./.gitignore ./.editorconfig ./.eslintignore \
+	./.eslintrc ./.php-cs-fixer.php ./composer.lock ./bin \
+	./phpstan.neon.dist ./phpunit.xml.dist ./tests \
+	./DOCKER_ENV ./docker_tag ./output.log ./.github
+
+cd ../
+
+# Create a zip file from the optimized plugin folder
+zip -rq pdc-faq.zip ./pdc-faq
+rm -rf ./pdc-faq
+
+echo "Zip completed @ $(pwd)/pdc-faq.zip"

composer.json

@@ -10,14 +10,15 @@
   ],
   "type": "wordpress-plugin",
   "require": {
-    "php": "^7.4|^8.0"
+    "php": "^7.4|^8.0",
+    "yahnis-elsts/plugin-update-checker": "^5.1"
   },
   "require-dev": {
     "mockery/mockery": "*",
     "phpunit/phpunit": "~8.0",
     "10up/wp_mock": "~0.4",
     "friendsofphp/php-cs-fixer": "^2.0",
-    "szepeviktor/phpstan-wordpress": "^0.6.0"
+    "szepeviktor/phpstan-wordpress": "^1.3.0"
   },
   "autoload": {
     "psr-4": {
@@ -38,6 +39,7 @@
     "test": [
       "@unit",
       "@integration"
-    ]
+    ],
+    "package": "chmod +x ./bin/package.sh && ./bin/package.sh"
   }
 }