From 53756607678e2449d816dd27f1da6e1c3b6650f9 Mon Sep 17 00:00:00 2001 From: Blackfaded Date: Mon, 12 Aug 2024 15:18:50 +0200 Subject: [PATCH 01/11] chore: exclude testfiles from sonar --- sonar-project.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sonar-project.properties b/sonar-project.properties index e40b928..3682ec3 100644 --- a/sonar-project.properties +++ b/sonar-project.properties @@ -8,4 +8,4 @@ sonar.typescript.tsconfigPath=./tsconfig.json sonar.javascript.lcov.reportPaths=./coverage/lcov.info sonar.coverage.exclusions=src/**/*.js,src/models/**,**/*index.ts,src/testutils/**,src/**/*.test.ts -sonar.exclusions=**/node_modules/**,**/*.spec.ts,src/models/**,src/testutils/** +sonar.exclusions=**/node_modules/**,**/*.spec.ts,**/*.test.ts,src/models/**,src/testutils/** From 19730c2c4ff0e7cf7ae3253a16d4cc08b33c2241 Mon Sep 17 00:00:00 2001 From: Blackfaded Date: Mon, 12 Aug 2024 15:18:59 +0200 Subject: [PATCH 02/11] chore: add licence to npm --- .npmignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.npmignore b/.npmignore index 6e8ae59..7eb8b9f 100644 --- a/.npmignore +++ b/.npmignore @@ -4,5 +4,6 @@ # But include these files and directories !package.json !README.md +!LICENSE !dist/ !dist/** From affd97ce41f4a0a6d335f003d15d513e09480f92 Mon Sep 17 00:00:00 2001 From: Blackfaded Date: Mon, 12 Aug 2024 15:19:09 +0200 Subject: [PATCH 03/11] docs: remove dev note --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 7a6ddd9..021798e 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,6 @@ [![npm](https://img.shields.io/npm/v/pcp-server-nodejs-sdk)](https://www.npmjs.com/package/pcp-server-nodejs-sdk) [![npm downloads](https://img.shields.io/npm/dw/pcp-server-nodejs-sdk)](https://www.npmjs.com/package/pcp-server-nodejs-sdk) -**NOTE:** This SDK is still under development. Some things may be broken, features may change in non-compatible ways or will be removed completely. - Welcome to the Node SDK for the PAYONE Commerce Platform! This repository contains a powerful, easy-to-use software development kit (SDK) designed to simplify the integration of online payment processing into your applications. ## Table of Contents From 80b405b57a8151db6a05562cd0f89c8b1dce4c54 Mon Sep 17 00:00:00 2001 From: Blackfaded Date: Tue, 13 Aug 2024 08:34:49 +0200 Subject: [PATCH 04/11] chore: update changelog --- CHANGELOG.md | 24 +++++++++++++++++++++++- version.sh | 3 +++ 2 files changed, 26 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 18d2149..0f6f3a1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,29 @@ -## 0.0.1 (2024-08-09) +## [0.0.2](https://github.com/PAYONE-GmbH/PCP-server-nodeJS-SDK/compare/e9a92f3001fe33df9bdad537b68f999b9e93e805...v0.0.2) (2024-08-12) + +### Bug Fixes + +* fix: use plain glob export, as otherwise enums cannot be imported ([663cbaa7789878b0db1c7936bf88d1627d4dddad](https://github.com/PAYONE-GmbH/PCP-server-nodeJS-SDK/commit/663cbaa7789878b0db1c7936bf88d1627d4dddad)) ### Documentation +* docs: add badges, note and formatting to readme ([df6461a8902c8aa6592d77203ad5a844d84d44e1](https://github.com/PAYONE-GmbH/PCP-server-nodeJS-SDK/commit/df6461a8902c8aa6592d77203ad5a844d84d44e1)) +* docs: add contributing guidelines ([3816787fbee8c7e8d686c8b37587e4c75f93b782](https://github.com/PAYONE-GmbH/PCP-server-nodeJS-SDK/commit/3816787fbee8c7e8d686c8b37587e4c75f93b782)) +* docs: adjust naming ([ff8d0bd2c53e86ea20799d1d871aeaae1d61ca9d](https://github.com/PAYONE-GmbH/PCP-server-nodeJS-SDK/commit/ff8d0bd2c53e86ea20799d1d871aeaae1d61ca9d)) +* docs: update readme ([487c39f4b99a7426a52c7e45471f87503986925a](https://github.com/PAYONE-GmbH/PCP-server-nodeJS-SDK/commit/487c39f4b99a7426a52c7e45471f87503986925a)) +* docs: update readme ([baa39d1afa94d9ab807324d9466921d1bcf56538](https://github.com/PAYONE-GmbH/PCP-server-nodeJS-SDK/commit/baa39d1afa94d9ab807324d9466921d1bcf56538)) * docs: update readme ([f3adc58a9b39a4170f4c686dde07bfc1c5dcb6b0](https://github.com/PAYONE-GmbH/PCP-server-nodeJS-SDK/commit/f3adc58a9b39a4170f4c686dde07bfc1c5dcb6b0)) * docs: update readme ([4d596a66f3007e3d96e0ef39cacd3f278f507fdc](https://github.com/PAYONE-GmbH/PCP-server-nodeJS-SDK/commit/4d596a66f3007e3d96e0ef39cacd3f278f507fdc)) +* docs: update readme and add sonar and npm badges ([0526b28226d87c19a9b0ea34a2778aba2ace829a](https://github.com/PAYONE-GmbH/PCP-server-nodeJS-SDK/commit/0526b28226d87c19a9b0ea34a2778aba2ace829a)) +* docs: update readme with build, test, and release instructions ([62a5c25619d74e43145f6c09424afb8b339980d5](https://github.com/PAYONE-GmbH/PCP-server-nodeJS-SDK/commit/62a5c25619d74e43145f6c09424afb8b339980d5)) + +### Features + +* feature(api-calls): discriminate between actual api error responses and retrieval errors ([26fa674bc6376351a778e400d01beb936bd719e2](https://github.com/PAYONE-GmbH/PCP-server-nodeJS-SDK/commit/26fa674bc6376351a778e400d01beb936bd719e2)) +* feat(api-clients): add client for payment execution, payment information and order management ([4434b586c90c90b5acd39e3f96f8532d38a93e8f](https://github.com/PAYONE-GmbH/PCP-server-nodeJS-SDK/commit/4434b586c90c90b5acd39e3f96f8532d38a93e8f)) +* feat(apple-pay-transformer): add return type to applePayPaymentToMobilePaymentMethodSpecificInput ([de8674f9fa9873e361a97cad5e1a1d83ed6202e3](https://github.com/PAYONE-GmbH/PCP-server-nodeJS-SDK/commit/de8674f9fa9873e361a97cad5e1a1d83ed6202e3)) +* feature(apple-pay): add models for payloads received from client communication with apple pay ([cd0e7538150c2a7d6bfc5086fff68137c0e085a9](https://github.com/PAYONE-GmbH/PCP-server-nodeJS-SDK/commit/cd0e7538150c2a7d6bfc5086fff68137c0e085a9)) +* feat(CheckoutsResponse): all fields are required ([adc1fb4908a6efeb48d466a755ca39cd023d2c69](https://github.com/PAYONE-GmbH/PCP-server-nodeJS-SDK/commit/adc1fb4908a6efeb48d466a755ca39cd023d2c69)) +* feat(commerce-case-client): use TypeError for missing arguments, handle void responses ([d815f275533559718e3add72a008af350c929290](https://github.com/PAYONE-GmbH/PCP-server-nodeJS-SDK/commit/d815f275533559718e3add72a008af350c929290)) +* feature(models): convert models to be only types ([ec7fecfad118a413b1aba8d1ba2ae953c9d818cd](https://github.com/PAYONE-GmbH/PCP-server-nodeJS-SDK/commit/ec7fecfad118a413b1aba8d1ba2ae953c9d818cd)) +* feat(order-model): references could be empty when send as response ([1dd2d51f398e528f65944faed04a1e98a8de16b2](https://github.com/PAYONE-GmbH/PCP-server-nodeJS-SDK/commit/1dd2d51f398e528f65944faed04a1e98a8de16b2)) diff --git a/version.sh b/version.sh index 6bcc680..f5d86fc 100755 --- a/version.sh +++ b/version.sh @@ -12,6 +12,9 @@ if [ -n "$NEW_VERSION" ]; then echo "Could not find $SERVER_META_INFO_PATH" exit 1 fi + npm run changelog + git add CHANGELOG.md + echo "Updated CHANGELOG.md" else echo "Script can only be run as npm version hook" From 3e6db98c00641163f4f1fdede66e1a825b6e893a Mon Sep 17 00:00:00 2001 From: Blackfaded Date: Tue, 13 Aug 2024 08:34:56 +0200 Subject: [PATCH 05/11] 0.0.3 --- CHANGELOG.md | 6 ++++++ package-lock.json | 4 ++-- package.json | 2 +- src/utils/ServerMetaInfo.ts | 2 +- 4 files changed, 10 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0f6f3a1..7e2ca54 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## [0.0.3](https://github.com/PAYONE-GmbH/PCP-server-nodeJS-SDK/compare/v0.0.2...v0.0.3) (2024-08-13) + +### Documentation + +* docs: remove dev note ([affd97ce41f4a0a6d335f003d15d513e09480f92](https://github.com/PAYONE-GmbH/PCP-server-nodeJS-SDK/commit/affd97ce41f4a0a6d335f003d15d513e09480f92)) + ## [0.0.2](https://github.com/PAYONE-GmbH/PCP-server-nodeJS-SDK/compare/e9a92f3001fe33df9bdad537b68f999b9e93e805...v0.0.2) (2024-08-12) ### Bug Fixes diff --git a/package-lock.json b/package-lock.json index 4ffa7a4..d1dceca 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "pcp-server-nodejs-sdk", - "version": "0.0.2", + "version": "0.0.3", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "pcp-server-nodejs-sdk", - "version": "0.0.2", + "version": "0.0.3", "license": "MIT", "dependencies": { "node-fetch": "3.3.2" diff --git a/package.json b/package.json index 6be480c..bdf2fe2 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "pcp-server-nodejs-sdk", - "version": "0.0.2", + "version": "0.0.3", "description": "", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/utils/ServerMetaInfo.ts b/src/utils/ServerMetaInfo.ts index 1709d6b..bafe43c 100644 --- a/src/utils/ServerMetaInfo.ts +++ b/src/utils/ServerMetaInfo.ts @@ -8,7 +8,7 @@ export class ServerMetaInfo { constructor(integrator?: string) { this.platformIdentifier = `${os.platform()}, node version is: ${process.version}`; - this.sdkIdentifier = 'NodeServerSDK/v0.0.2'; // version gets updated with the prepare-release.sh script + this.sdkIdentifier = 'NodeServerSDK/v0.0.3'; // version gets updated with the prepare-release.sh script this.sdkCreator = 'PAYONE GmbH'; this.integrator = integrator || ''; } From 941cfc5ca655f93cd57a80b2b37878a72a41d26b Mon Sep 17 00:00:00 2001 From: Blackfaded Date: Tue, 13 Aug 2024 08:35:28 +0200 Subject: [PATCH 06/11] chore: add test file --- src/utils/ServerMetaInfo.test.ts | 2 +- version.sh | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/src/utils/ServerMetaInfo.test.ts b/src/utils/ServerMetaInfo.test.ts index 74dd7a6..2dd2c4a 100644 --- a/src/utils/ServerMetaInfo.test.ts +++ b/src/utils/ServerMetaInfo.test.ts @@ -10,7 +10,7 @@ describe('ServerMetaInfo', () => { test('initializes with correct values', () => { const serverMetaInfo = new ServerMetaInfo(); expect(serverMetaInfo.platformIdentifier).toBe(`${os.platform()}, node version is: ${process.version}`); - expect(serverMetaInfo.sdkIdentifier).toBe('NodeServerSDK/v0.0.2'); + expect(serverMetaInfo.sdkIdentifier).toBe('NodeServerSDK/v0.0.3'); expect(serverMetaInfo.sdkCreator).toBe('PAYONE GmbH'); }); }); diff --git a/version.sh b/version.sh index f5d86fc..325fc34 100755 --- a/version.sh +++ b/version.sh @@ -8,6 +8,9 @@ if [ -n "$NEW_VERSION" ]; then sed -i '' "s/NodeServerSDK\/v[0-9]*\.[0-9]*\.[0-9]*/NodeServerSDK\/v$NEW_VERSION/g" ${SERVER_META_INFO_TEST_PATH} git add $SERVER_META_INFO_PATH echo "Updated $SERVER_META_INFO_PATH with version $NEW_VERSION" + git add $SERVER_META_INFO_TEST_PATH + echo "Updated $SERVER_META_INFO_TEST_PATH with version $NEW_VERSION" + else echo "Could not find $SERVER_META_INFO_PATH" exit 1 From 34c1ea672b9fbc9264749af42c7a0adb137038ec Mon Sep 17 00:00:00 2001 From: Blackfaded Date: Tue, 13 Aug 2024 08:43:30 +0200 Subject: [PATCH 07/11] chore: add bumping of example app dep when version bumps --- example-app/package-lock.json | 95 +++++++++++++++++++++++++++++++++++ example-app/package.json | 4 +- version.sh | 9 ++++ 3 files changed, 107 insertions(+), 1 deletion(-) diff --git a/example-app/package-lock.json b/example-app/package-lock.json index b34a811..9368a24 100644 --- a/example-app/package-lock.json +++ b/example-app/package-lock.json @@ -8,6 +8,9 @@ "name": "example-app", "version": "1.0.0", "license": "MIT", + "dependencies": { + "pcp-server-nodejs-sdk": "0.0.3" + }, "devDependencies": { "tsx": "4.17.0", "typescript": "5.5.4" @@ -397,6 +400,14 @@ "node": ">=18" } }, + "node_modules/data-uri-to-buffer": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/data-uri-to-buffer/-/data-uri-to-buffer-4.0.1.tgz", + "integrity": "sha512-0R9ikRb668HB7QDxT1vkpuUBtqc53YyAwMwGeUFKRojY/NWKvdZ+9UYtRfGmhqNbRkTSVpMbmyhXipFFv2cb/A==", + "engines": { + "node": ">= 12" + } + }, "node_modules/esbuild": { "version": "0.23.0", "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.23.0.tgz", @@ -436,6 +447,39 @@ "@esbuild/win32-x64": "0.23.0" } }, + "node_modules/fetch-blob": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/fetch-blob/-/fetch-blob-3.2.0.tgz", + "integrity": "sha512-7yAQpD2UMJzLi1Dqv7qFYnPbaPx7ZfFK6PiIxQ4PfkGPyNyl2Ugx+a/umUonmKqjhM4DnfbMvdX6otXq83soQQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/jimmywarting" + }, + { + "type": "paypal", + "url": "https://paypal.me/jimmywarting" + } + ], + "dependencies": { + "node-domexception": "^1.0.0", + "web-streams-polyfill": "^3.0.3" + }, + "engines": { + "node": "^12.20 || >= 14.13" + } + }, + "node_modules/formdata-polyfill": { + "version": "4.0.10", + "resolved": "https://registry.npmjs.org/formdata-polyfill/-/formdata-polyfill-4.0.10.tgz", + "integrity": "sha512-buewHzMvYL29jdeQTVILecSaZKnt/RJWjoZCF5OW60Z67/GmSLBkOFM7qh1PI3zFNtJbaZL5eQu1vLfazOwj4g==", + "dependencies": { + "fetch-blob": "^3.1.2" + }, + "engines": { + "node": ">=12.20.0" + } + }, "node_modules/fsevents": { "version": "2.3.3", "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", @@ -462,6 +506,49 @@ "url": "https://github.com/privatenumber/get-tsconfig?sponsor=1" } }, + "node_modules/node-domexception": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/node-domexception/-/node-domexception-1.0.0.tgz", + "integrity": "sha512-/jKZoMpw0F8GRwl4/eLROPA3cfcXtLApP0QzLmUT/HuPCZWyB7IY9ZrMeKw2O/nFIqPQB3PVM9aYm0F312AXDQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/jimmywarting" + }, + { + "type": "github", + "url": "https://paypal.me/jimmywarting" + } + ], + "engines": { + "node": ">=10.5.0" + } + }, + "node_modules/node-fetch": { + "version": "3.3.2", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-3.3.2.tgz", + "integrity": "sha512-dRB78srN/l6gqWulah9SrxeYnxeddIG30+GOqK/9OlLVyLg3HPnr6SqOWTWOXKRwC2eGYCkZ59NNuSgvSrpgOA==", + "dependencies": { + "data-uri-to-buffer": "^4.0.0", + "fetch-blob": "^3.1.4", + "formdata-polyfill": "^4.0.10" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/node-fetch" + } + }, + "node_modules/pcp-server-nodejs-sdk": { + "version": "0.0.2", + "resolved": "https://registry.npmjs.org/pcp-server-nodejs-sdk/-/pcp-server-nodejs-sdk-0.0.2.tgz", + "integrity": "sha512-GL1K6edsNznnmeRFVey7oy5Suu/MSc6ySboEXCtrvJLoYVFPVn0Q1iaP1q6BNpdIbhkA8p7oiPJBhL1e7b6Jcw==", + "dependencies": { + "node-fetch": "3.3.2" + } + }, "node_modules/resolve-pkg-maps": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/resolve-pkg-maps/-/resolve-pkg-maps-1.0.0.tgz", @@ -502,6 +589,14 @@ "engines": { "node": ">=14.17" } + }, + "node_modules/web-streams-polyfill": { + "version": "3.3.3", + "resolved": "https://registry.npmjs.org/web-streams-polyfill/-/web-streams-polyfill-3.3.3.tgz", + "integrity": "sha512-d2JWLCivmZYTSIoge9MsgFCZrt571BikcWGYkjC1khllbTeDlGqZ2D8vD8E/lJa8WGWbb7Plm8/XJYV7IJHZZw==", + "engines": { + "node": ">= 8" + } } } } diff --git a/example-app/package.json b/example-app/package.json index c0ac4aa..28ff702 100644 --- a/example-app/package.json +++ b/example-app/package.json @@ -9,8 +9,10 @@ }, "author": "", "license": "MIT", + "dependencies": { + "pcp-server-nodejs-sdk": "0.0.3" + }, "devDependencies": { - "pcp-server-nodejs-sdk": "0.0.1", "tsx": "4.17.0", "typescript": "5.5.4" } diff --git a/version.sh b/version.sh index 325fc34..fecd049 100755 --- a/version.sh +++ b/version.sh @@ -1,15 +1,24 @@ SERVER_META_INFO_PATH='./src/utils/ServerMetaInfo.ts' SERVER_META_INFO_TEST_PATH='./src/utils/ServerMetaInfo.test.ts' +EXAMPLE_APP_PACKAGE_JSON_PATH='./example-app/package.json' +EXAMPLE_APP_PACKAGE_JSON_LOCK_PATH='./example-app/package-lock.json' NEW_VERSION=$npm_package_version if [ -n "$NEW_VERSION" ]; then if [ -f $SERVER_META_INFO_PATH ]; then sed -i '' "s/NodeServerSDK\/v[0-9]*\.[0-9]*\.[0-9]*/NodeServerSDK\/v$NEW_VERSION/g" ${SERVER_META_INFO_PATH} sed -i '' "s/NodeServerSDK\/v[0-9]*\.[0-9]*\.[0-9]*/NodeServerSDK\/v$NEW_VERSION/g" ${SERVER_META_INFO_TEST_PATH} + sed -i '' "s/\"pcp-server-nodejs-sdk\": \"[0-9]*\.[0-9]*\.[0-9]*\"/\"pcp-server-nodejs-sdk\": \"$NEW_VERSION\"/g" ${EXAMPLE_APP_PACKAGE_JSON_PATH} + sed -i '' "s/\"pcp-server-nodejs-sdk\": \"[0-9]*\.[0-9]*\.[0-9]*\"/\"pcp-server-nodejs-sdk\": \"$NEW_VERSION\"/g" ${EXAMPLE_APP_PACKAGE_JSON_LOCK_PATH} + git add $SERVER_META_INFO_PATH echo "Updated $SERVER_META_INFO_PATH with version $NEW_VERSION" git add $SERVER_META_INFO_TEST_PATH echo "Updated $SERVER_META_INFO_TEST_PATH with version $NEW_VERSION" + git add $EXAMPLE_APP_PACKAGE_JSON_PATH + echo "Updated $EXAMPLE_APP_PACKAGE_JSON_PATH with version $NEW_VERSION" + git add $EXAMPLE_APP_PACKAGE_JSON_LOCK_PATH + echo "Updated $EXAMPLE_APP_PACKAGE_JSON_LOCK_PATH with version $NEW_VERSION" else echo "Could not find $SERVER_META_INFO_PATH" From 91825b3d29d221e468d520d144f0efa654c5ae2d Mon Sep 17 00:00:00 2001 From: Blackfaded Date: Tue, 13 Aug 2024 08:46:50 +0200 Subject: [PATCH 08/11] chore: check for all files --- version.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/version.sh b/version.sh index fecd049..f2f14a4 100755 --- a/version.sh +++ b/version.sh @@ -5,7 +5,7 @@ EXAMPLE_APP_PACKAGE_JSON_LOCK_PATH='./example-app/package-lock.json' NEW_VERSION=$npm_package_version if [ -n "$NEW_VERSION" ]; then - if [ -f $SERVER_META_INFO_PATH ]; then + if [[ -f $SERVER_META_INFO_PATH && -f $SERVER_META_INFO_TEST_PATH && -f $EXAMPLE_APP_PACKAGE_JSON_PATH && $EXAMPLE_APP_PACKAGE_JSON_LOCK_PATH ]]; then sed -i '' "s/NodeServerSDK\/v[0-9]*\.[0-9]*\.[0-9]*/NodeServerSDK\/v$NEW_VERSION/g" ${SERVER_META_INFO_PATH} sed -i '' "s/NodeServerSDK\/v[0-9]*\.[0-9]*\.[0-9]*/NodeServerSDK\/v$NEW_VERSION/g" ${SERVER_META_INFO_TEST_PATH} sed -i '' "s/\"pcp-server-nodejs-sdk\": \"[0-9]*\.[0-9]*\.[0-9]*\"/\"pcp-server-nodejs-sdk\": \"$NEW_VERSION\"/g" ${EXAMPLE_APP_PACKAGE_JSON_PATH} @@ -21,7 +21,7 @@ if [ -n "$NEW_VERSION" ]; then echo "Updated $EXAMPLE_APP_PACKAGE_JSON_LOCK_PATH with version $NEW_VERSION" else - echo "Could not find $SERVER_META_INFO_PATH" + echo "Could not find some files to update" exit 1 fi npm run changelog From f2f3f884d69fc63881f142e8eb8894496af11107 Mon Sep 17 00:00:00 2001 From: Blackfaded Date: Tue, 13 Aug 2024 08:47:50 +0200 Subject: [PATCH 09/11] chore: order script --- version.sh | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/version.sh b/version.sh index f2f14a4..9d28e80 100755 --- a/version.sh +++ b/version.sh @@ -12,12 +12,12 @@ if [ -n "$NEW_VERSION" ]; then sed -i '' "s/\"pcp-server-nodejs-sdk\": \"[0-9]*\.[0-9]*\.[0-9]*\"/\"pcp-server-nodejs-sdk\": \"$NEW_VERSION\"/g" ${EXAMPLE_APP_PACKAGE_JSON_LOCK_PATH} git add $SERVER_META_INFO_PATH - echo "Updated $SERVER_META_INFO_PATH with version $NEW_VERSION" git add $SERVER_META_INFO_TEST_PATH - echo "Updated $SERVER_META_INFO_TEST_PATH with version $NEW_VERSION" git add $EXAMPLE_APP_PACKAGE_JSON_PATH - echo "Updated $EXAMPLE_APP_PACKAGE_JSON_PATH with version $NEW_VERSION" git add $EXAMPLE_APP_PACKAGE_JSON_LOCK_PATH + echo "Updated $SERVER_META_INFO_PATH with version $NEW_VERSION" + echo "Updated $SERVER_META_INFO_TEST_PATH with version $NEW_VERSION" + echo "Updated $EXAMPLE_APP_PACKAGE_JSON_PATH with version $NEW_VERSION" echo "Updated $EXAMPLE_APP_PACKAGE_JSON_LOCK_PATH with version $NEW_VERSION" else From 34e0d08efc83750f37951c495a901da6898fccbd Mon Sep 17 00:00:00 2001 From: Blackfaded Date: Tue, 13 Aug 2024 08:51:28 +0200 Subject: [PATCH 10/11] docs: update changelog generation docs --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 021798e..f42671a 100644 --- a/README.md +++ b/README.md @@ -132,7 +132,7 @@ npm version major|minor|patch #### Changelog Generation with Conventional Changelog -After versioning, it is recommended to manually trigger the changelog generation script (which uses [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog)). +The changelog gets generated automatically when the npm version gets bumped via `npm version major|minor|patch` within the `version.sh` script. 1. **Conventional Commit Messages**: From 04b8d42de81097407f885793cbdd786d3c5afdce Mon Sep 17 00:00:00 2001 From: Blackfaded Date: Tue, 13 Aug 2024 08:55:53 +0200 Subject: [PATCH 11/11] docs: remove manual changelog generation hint --- README.md | 7 ------- 1 file changed, 7 deletions(-) diff --git a/README.md b/README.md index f42671a..8b72525 100644 --- a/README.md +++ b/README.md @@ -144,13 +144,6 @@ The changelog gets generated automatically when the npm version gets bumped via - We enforce conventional commit messages using [Lefthook](https://github.com/evilmartians/lefthook) with [commitlint](https://github.com/conventional-changelog/commitlint). - This setup ensures that all commit messages are validated before they are committed. -3. **Generate Changelog**: - - Run the changelog generation script to update the `CHANGELOG.md` file: - ```sh - npm run changelog - ``` - - Review and commit the updated changelog before proceeding with the release. - #### Merging the Release Branch - Create PR on develop branch