Skip to content

WIP: Update packages to use apibuilder.engines #171

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 5, 2022
Merged

WIP: Update packages to use apibuilder.engines #171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c678f6c
WIP
alasdairhurst Apr 4, 2022
06764e2
Added Changelog entries
Apr 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions api-builder-plugin-dc-postgres/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 3 additions & 5 deletions api-builder-plugin-dc-postgres/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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",
Expand All @@ -21,7 +21,8 @@
"api-builder"
],
"engines": {
"node": ">= 8.9"
"node": ">= 8.9",
"apibuilder": ">= 4.0.0"
},
"license": "Apache-2.0",
"files": [
Expand All @@ -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"
}
Expand Down
4 changes: 4 additions & 0 deletions api-builder-plugin-fc-jira/Changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions api-builder-plugin-fc-jira/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
5 changes: 5 additions & 0 deletions api-builder-plugin-fc-sap-lama/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions api-builder-plugin-fc-sap-lama/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 4 additions & 0 deletions api-builder-plugin-fc-syncplicity/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions api-builder-plugin-fc-syncplicity/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 4 additions & 0 deletions api-builder-plugin-fn-aws-athena/Changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 2 additions & 4 deletions api-builder-plugin-fn-aws-athena/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
"connector"
],
"engines": {
"node": ">= 10.0"
"node": ">= 10.0",
"apibuilder": ">= 4.64.1"
},
"homepage": "https://github.com/Axway-API-Builder-Ext/api-builder-extras/tree/master/api-builder-plugin-fn-aws-athena",
"bugs": {
Expand All @@ -36,9 +37,6 @@
"athena-express": "^7.0.3",
"aws-sdk": "^2.903.0"
},
"peerDependencies": {
"@axway/api-builder-runtime": "^4.64.1"
},
"devDependencies": {
"@axway/api-builder-test-utils": "^1.4.0",
"chai": "^4.3.4",
Expand Down
3 changes: 3 additions & 0 deletions api-builder-plugin-fn-aws-lambda/Changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ 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.

### Fixed
- Documentation links

Expand Down
6 changes: 2 additions & 4 deletions api-builder-plugin-fn-aws-lambda/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@
"url": "https://github.com/Axway-API-Builder-Ext/api-builder-extras.git"
},
"engines": {
"node": ">= 10.0"
"node": ">= 10.0",
"apibuilder": ">= 4.22.0"
},
"main": "src/index.js",
"files": [
Expand All @@ -34,9 +35,6 @@
"@axway/api-builder-sdk": "^0.2.0",
"aws-sdk": "^2.918.0"
},
"peerDependencies": {
"@axway/api-builder-runtime": "^4.22.0"
},
"devDependencies": {
"chai": "^4.3.4",
"mocha": "^9.1.4",
Expand Down
4 changes: 4 additions & 0 deletions api-builder-plugin-fn-elasticsearch/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

## [3.0.0] 2022-02-28
### Security
- Updated @elastic/elasticsearch to version 8.0.0 to add support for Elasticsearch 8
Expand Down
6 changes: 2 additions & 4 deletions api-builder-plugin-fn-elasticsearch/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@
"url": "https://github.com/Axway-API-Builder-Ext/api-builder-extras.git"
},
"engines": {
"node": ">= 10.0"
"node": ">= 10.0",
"apibuilder": ">= 4.41.1"
},
"main": "src/index.js",
"files": [
Expand All @@ -34,9 +35,6 @@
"deep-equal": "^2.0.5",
"simple-mock": "^0.8.0"
},
"peerDependencies": {
"@axway/api-builder-runtime": "^4.41.1"
},
"devDependencies": {
"@axway/api-builder-test-utils": "^1.3.0",
"chai": "^4.3.4",
Expand Down
4 changes: 4 additions & 0 deletions api-builder-plugin-fn-file/Changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

## [0.0.9] 2022-02-01
### Fixed
- Documentation links
Expand Down
6 changes: 2 additions & 4 deletions api-builder-plugin-fn-file/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@
"url": "https://github.com/Axway-API-Builder-Ext/api-builder-extras.git"
},
"engines": {
"node": ">=10.0"
"node": ">=10.0",
"apibuilder": ">= 4.5.0"
},
"main": "src/index.js",
"files": [
Expand All @@ -35,9 +36,6 @@
"csv-parse": "^4.15.3",
"lodash": "^4.17.21"
},
"peerDependencies": {
"@axway/api-builder-runtime": "^4.5.0"
},
"devDependencies": {
"@axway/api-builder-test-utils": "^1.1.4",
"chai": "^4.3.4",
Expand Down
4 changes: 4 additions & 0 deletions api-builder-plugin-fn-foreach/Changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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] 2021-05-31
### Security
- Now using new API-Builder SDK to solve a number of security issues
Expand Down
3 changes: 2 additions & 1 deletion api-builder-plugin-fn-foreach/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@
"url": "https://github.com/Axway-API-Builder-Ext/api-builder-extras.git"
},
"engines": {
"node": ">= 8.9"
"node": ">= 8.9",
"apibuilder": ">= 4.66.0"
},
"main": "src/index.js",
"files": [
Expand Down
4 changes: 4 additions & 0 deletions api-builder-plugin-fn-google-maps/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.1.0] 2022-02-03
### Fixed
- Documentation links
Expand Down
6 changes: 2 additions & 4 deletions api-builder-plugin-fn-google-maps/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@
"url": "https://github.com/Axway-API-Builder-Ext/api-builder-extras.git"
},
"engines": {
"node": ">= 10.0"
"node": ">= 10.0",
"apibuilder": ">= 4.22.0"
},
"main": "src/index.js",
"files": [
Expand All @@ -35,9 +36,6 @@
"@axway/api-builder-project-utils": "^1.0.3",
"@googlemaps/google-maps-services-js": "^3.3.8"
},
"peerDependencies": {
"@axway/api-builder-runtime": "^4.22.0"
},
"devDependencies": {
"chai": "^4.3.4",
"mocha": "^9.2.0",
Expand Down
4 changes: 4 additions & 0 deletions api-builder-plugin-fn-kafka-producer/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

## [0.1.1] 2022-02-01
### Fixed
- Documentation links
Expand Down
6 changes: 2 additions & 4 deletions api-builder-plugin-fn-kafka-producer/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@
"url": "https://github.com/Axway-API-Builder-Ext/api-builder-extras.git"
},
"engines": {
"node": ">= 12.15"
"node": ">= 12.15",
"apibuilder": ">= 4.22.0"
},
"main": "src/index.js",
"files": [
Expand All @@ -33,9 +34,6 @@
"@axway/api-builder-project-utils": "^1.0.3",
"kafkajs": "^1.12.0"
},
"peerDependencies": {
"@axway/api-builder-runtime": "^4.22.0"
},
"devDependencies": {
"chai": "^4.1.2",
"mocha": "^9.2.0"
Expand Down
4 changes: 4 additions & 0 deletions api-builder-plugin-fn-mongodb/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.2] 2022-02-03
### Fixed
- Documentation links
Expand Down
Loading