From 7caed3a461a833b1bcb00cb08f0fa96a7c870108 Mon Sep 17 00:00:00 2001 From: Igor Goltsov Date: Tue, 19 Oct 2021 16:33:41 +0300 Subject: [PATCH] MPGS-580: Add a file with release instructions for every module --- CHANGELOG.md | 16 +++++++++++++++ RELEASE.md | 46 ++++++++++++++++++++++++++++++++++++++++++++ composer.json | 1 + simplifycommerce.php | 2 +- 4 files changed, 64 insertions(+), 1 deletion(-) create mode 100644 CHANGELOG.md create mode 100644 RELEASE.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..82cdef6 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,16 @@ +# Changelog +All notable changes to this project will be documented in this file. + + +## [2.2.0] - 2021-10-19 +### Changed +- Branding Update +- Add Embedded Payment Option + +### Fixed +- Remove unnecessary property to make module compatible with the new version of PrestaShop +- Modal Payment Option doesn't work on the new version of PrestaShop +- Payment details are missed for the Order in the Admin Panel + + +## [2.1.0] - 2020-10-23 diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000..1b52a99 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,46 @@ +# Release documentation + +### Pre-requisites +In order to release a new version of the module, you will need the following: + +1. Necessary permissions to the Github repository to create tags and releases. +2. All the required code is merged to target branch. +3. Ensure that the module's [CHANGELOG.md](CHANGELOG.md) file has been updated to contain details of the release you are planning to make. +4. Clone of the Github repository in a local computer (local repo). + +You should then follow these steps: + +## 1. Merge necessary Pull Requests +Before creating a release, check that all pull requests are merged into the agreed target branch, usually "master". + +## 2. Draft a release in Github +Create a release by clicking on "Draft a new release". + +Enter new release version number to "Choose a tag" box, the same number as in the project's **composer.json** file, for example "1.0.1". + +For the Target, choose the "master" branch or a different branch if it was previously agreed. + +For Release title, enter something more user friendly, for example "Version 1.0.1" + +Leave release description blank for now. + +Click on the "Publish release" button. + +## 3. Create dist +In local repo, enter following commands to create a dist zip file, in the example 1.0.1 is used, make sure this is replaced by the correct tag name + +``` +git fetch --tags --all +git archive 1.0.1 -o module-dist.zip +``` + +Created file module-dist.zip contains the distributable code for this module. + +## 4. Add assets and finalise the release +In the Github UI, switch to edit the release you created in step 2. The URL will contain something like /edit/1.0.1, for example. + +Upload the module-dist.zip into the designated area in the release edit page. + +Populate the release description with the information about the version that you can find in the [CHANGELOG.md](CHANGELOG.md) file. + +Click on the "Update release" button, and inform the development team that the release has been published. diff --git a/composer.json b/composer.json index fb9973d..ac956fc 100644 --- a/composer.json +++ b/composer.json @@ -3,6 +3,7 @@ "description": "Payments made easy - Start securely accepting card payments instantly.", "homepage": "https://github.com/PrestaShop/simplifycommerce", "license": "BSD 3-Clause license", + "version": "2.2.0", "authors": [ { "name": "Mastercard", diff --git a/simplifycommerce.php b/simplifycommerce.php index bdb029b..8a97163 100644 --- a/simplifycommerce.php +++ b/simplifycommerce.php @@ -59,7 +59,7 @@ public function __construct() { $this->name = 'simplifycommerce'; $this->tab = 'payments_gateways'; - $this->version = '2.1.0'; + $this->version = '2.2.0'; $this->author = 'Mastercard'; $this->ps_versions_compliancy = array('min' => '1.7', 'max' => _PS_VERSION_);