Merge pull request #171 from alasdairhurst/rdpp-6933

WIP: Update packages to use apibuilder.engines

Author: Chris Wiechmann

README.md

@@ -71,24 +71,25 @@ If you found an issue or you have improved an existing plugin yourself, we highl
     - Especially the fields: 
         - __name__: should start with: `@axway-api-builder-ext/api-builder-plugin....`
         - __version__: Stable has a version 1.x.x, all other something 0.x.x
-        - __description__: Provide a meaningful description. This will appear in the API-Builder UI plugin dialog
-        - __author__: Add your GitHub ID or email address (this is used to assign issues/pullrequests)
+        - __description__: Provide a meaningful description. This will appear in the API Builder UI "Plugins" page
+        - __author__: Add your GitHub ID or email address (this is used to assign issues/pull requests)
         - __homepage__: Should point to your unique folder within this repository
         - __keywords__: Add more keywords to make it easier to discover your plugin
+        -__engines.apibuilder__: Documents range of API Builder versions that the plugin is compatible with. Remember that modifying this to increase the minimum compatible API Builder version is a breaking change, so update the major version of your plugin when you do so.
     - There might be more changes needed depending on what your plugin does
 7. Create new GitHub actions based on the templates `.github/workflows/*_template`
     - these workflows are used to automatically tests and release/publish your plugin
-    - Replace all occurencies of `NAME_OF_YOUR_PLUGIN` in both workflow files with a valid name not longer than 20 characters
-    - Replace all occurencies of `THE_FOLDER_NAME_OF_YOUR_PLUGIN` with the folder name of your plugin
+    - Replace all occurrences of `NAME_OF_YOUR_PLUGIN` in both workflow files with a valid name not longer than 20 characters
+    - Replace all occurrences of `THE_FOLDER_NAME_OF_YOUR_PLUGIN` with the folder name of your plugin
     - You may skip this step and we will add the workflows for you
 8. Provide a README.md 
     - What your plugin does
     - How to use it (e.g. add images, examples, etc.) to make it easy for developers to understand it
-    - Mention potential limitions/caveats/known issues
+    - Mention potential limitations/caveats/known issues
 9. Create a package-lock.json
     - Run `npm install` to create a `package-lock.json`
     - This is required to lock down used modules before testing and releasing it
-10. Commit/Push your changes to your forked repository and finally create a [Pull-Reuqest][13]
+10. Commit/Push your changes to your forked repository and finally create a [Pull-Request][13]
     - We take it from there, review your plugin or changes you propose 
     - if required, we propose or add further changes or just start a conversation when having questions
     - Finally the changes are merged into the master branch of this repository 

api-builder-plugin-dc-postgres/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [Unreleased]
+### Changed
+- Now uses `apibuilder.engines` for documenting compatibility with API Builder.
+
 ## [2.0.1] 2022-02-03
 ### Fixed
 - Documentation links

api-builder-plugin-dc-postgres/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@axway-api-builder-ext/api-builder-plugin-dc-postgres",
   "description": "PostgreSQL data connector for Axway API Builder",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "author": {
     "email": "cwiechmann@axway.com",
     "name": "Chris Wiechmann",
@@ -21,7 +21,8 @@
     "api-builder"
   ],
   "engines": {
-    "node": ">= 8.9"
+    "node": ">= 8.9",
+    "apibuilder": ">= 4.0.0"
   },
   "license": "Apache-2.0",
   "files": [
@@ -37,9 +38,6 @@
     "pg": "^8.7.1",
     "semver": "^5.4.0"
   },
-  "peerDependencies": {
-    "@axway/api-builder-runtime": "^4.0.0"
-  },
   "scripts": {
     "postinstall": "api-builder-copy ./config/postgres.default.js ./conf"
   }

api-builder-plugin-fc-jira/Changelog.md

@@ -5,6 +5,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [Unreleased]
+### Changed
+- Now uses `apibuilder.engines` for documenting compatibility with API Builder.
+
 ## [0.0.8] 2022-02-03
 
 ### Security

api-builder-plugin-fc-jira/package.json

@@ -26,14 +26,14 @@
     "README.md",
     "LICENSE"
   ],
+  "engines": {
+    "node": ">= 8.9",
+    "apibuilder": ">= 4.64.1"
+  },
   "dependencies": {
     "@axway/api-builder-oas-flow-node": "^1.2.3"
   },
-  "peerDependencies": {
-    "@axway/api-builder-runtime": "^4.64.1"
-  },
   "devDependencies": {
-    "@axway/api-builder-runtime": "^4.64.1",
     "@axway/api-builder-test-utils": "^1.1.12",
     "chai": "^4.1.2",
     "mocha": "^9.1.4"

api-builder-plugin-fc-sap-lama/CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+
+## [Unreleased]
+### Changed
+- Now uses `apibuilder.engines` for documenting compatibility with API Builder.
+
 ## [1.0.10] 2022-02-03
 ### Fixed
 - Documentation links

api-builder-plugin-fc-sap-lama/package.json

@@ -25,14 +25,14 @@
     "README.md",
     "LICENSE"
   ],
+  "engines": {
+    "node": ">= 8.9",
+    "apibuilder": ">= 4.64.1"
+  },
   "dependencies": {
     "@axway/api-builder-oas-flow-node": "^1.2.3"
   },
-  "peerDependencies": {
-    "@axway/api-builder-runtime": "^4.64.1"
-  },
   "devDependencies": {
-    "@axway/api-builder-runtime": "^4.64.1",
     "@axway/api-builder-test-utils": "^1.1.12",
     "chai": "^4.3.4",
     "mocha": "^9.1.4"

api-builder-plugin-fc-syncplicity/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [Unreleased]
+### Changed
+- Now uses `apibuilder.engines` for documenting compatibility with API Builder.
+
 ## [1.0.5] 2022-02-03
 ### Security
 - Updated dependencies to fix security issues

api-builder-plugin-fc-syncplicity/package.json

@@ -24,15 +24,15 @@
     "openapi",
     "README.md",
     "LICENSE"
-  ],
+  ], 
+  "engines": {
+    "node": ">= 8.9",
+    "apibuilder": ">= 4.71.0"
+  },
   "dependencies": {
     "@axway/api-builder-oas-flow-node": "^2.0.3"
   },
-  "peerDependencies": {
-    "@axway/api-builder-runtime": "^4.71.0"
-  },
   "devDependencies": {
-    "@axway/api-builder-runtime": "^4.71.0",
     "@axway/api-builder-test-utils": "^1.5.1",
     "chai": "^4.3.4",
     "mocha": "^9.1.3"

api-builder-plugin-fn-aws-athena/Changelog.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [Unreleased]
+### Changed
+- Now uses `apibuilder.engines` for documenting compatibility with API Builder.
+
 ## [2.0.0] 2022-02-03
 ### Security
 - Updated depencencies to fix security issues