[DEV-2435] Create New Package for SOAP API scripts #1536

Sebastiano-Bertolin · 2025-07-07T14:20:25Z

List of Changes

Move script generateSoapApiRepositoryList to a new package

Motivation and Context

Separation of concern

How Has This Been Tested?

Manually

Screenshots (if appropriate):

Types of changes

Chore (nothing changes by a user perspective)
Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

My change requires a change to the documentation.
I have updated the documentation accordingly.

changeset-bot · 2025-07-07T14:20:29Z

🦋 Changeset detected

Latest commit: b1fdd0a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
gitbook-docs	Patch
soap-api-data	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

packages/soap-api-data/package.json

…ipts

marcobottaro

You should add changeset files

…ipts

…soap-api-scripts' into DEV-2435-create-new-package-for-soap-api-scripts

MarBert

I see you have two changesets. "There can be only one!" (cit.)

packages/soap-api-data/package.json

github-actions · 2025-08-22T02:35:37Z

This pull request is stale because it has been open for 14 days with no activity. If the pull request is still valid, please update it within 21 days to keep it open or merge it, otherwise it will be closed automatically.

…ackage-for-soap-api-scripts

.changeset/strong-paths-take.md

packages/soap-api-data/src/helpers/fetchFromStrapi.ts

Co-authored-by: tommaso1 <tommasorosso1@gmail.com>

…ipts

MarcoPonchia

Maybe is better to add an example env file like packages/gitbook-docs/.env.default to show the necessary env var to run it locally

…ipts

… for example env files

Sebastiano-Bertolin · 2025-09-24T09:21:08Z

Maybe is better to add an example env file like packages/gitbook-docs/.env.default to show the necessary env var to run it locally

Done 👍

Copilot

Pull Request Overview

This PR creates a new package soap-api-data to separate SOAP API-related functionality from the gitbook-docs package, following separation of concerns principles.

Moves the generateSoapApiRepositoriesList script from gitbook-docs to the new soap-api-data package
Updates GitHub Actions workflow to use the new package location
Creates proper package structure with TypeScript configuration and helper utilities

Reviewed Changes

Copilot reviewed 8 out of 11 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
packages/soap-api-data/tsconfig.json	TypeScript configuration for the new package
packages/soap-api-data/src/helpers/fetchFromStrapi.ts	Helper utilities for fetching data from Strapi API
packages/soap-api-data/package.json	Package configuration with build scripts and dependencies
packages/soap-api-data/.eslintrc.json	ESLint configuration extending custom rules
packages/soap-api-data/.env.default	Default environment variables for the package
packages/gitbook-docs/package.json	Removes the moved script from gitbook-docs package
.github/actions/clone-soap-api-repos/action.yaml	Updates workflow to use new package location
.changeset/true-pandas-act.md	Changeset documenting the package changes

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-24T09:21:19Z

packages/soap-api-data/src/helpers/fetchFromStrapi.ts

+// In case of an error, the error will be thrown
+export async function fetchFromStrapi<T>(
+  url: string
+): Promise<{ data: T[]; responseJson?: any }> {


The return type uses any for responseJson which reduces type safety. Consider defining a more specific interface for the Strapi response structure or using unknown if the structure is truly variable.

Suggested change

): Promise<{ data: T[]; responseJson?: any }> {

): Promise<{ data: T[]; responseJson?: unknown }> {

Copilot · 2025-09-24T09:21:20Z

packages/soap-api-data/src/helpers/fetchFromStrapi.ts

+async function fetchFromStrapiResponse(url: string) {
+  console.log('Fetching from Strapi...');
+  const strapiEndpoint = process.env.STRAPI_ENDPOINT;
+  const strapiApiToken = process.env.STRAPI_API_TOKEN;
+
+  if (!strapiEndpoint || !strapiApiToken) {
+    console.error('Missing Strapi configuration in environment variables');
+    throw new Error('Missing Strapi configuration in environment variables');


The error message is duplicated between the console.error and thrown Error. Consider extracting this to a constant to avoid duplication and improve maintainability.

Suggested change

async function fetchFromStrapiResponse(url: string) {

console.log('Fetching from Strapi...');

const strapiEndpoint = process.env.STRAPI_ENDPOINT;

const strapiApiToken = process.env.STRAPI_API_TOKEN;

if (!strapiEndpoint || !strapiApiToken) {

console.error('Missing Strapi configuration in environment variables');

throw new Error('Missing Strapi configuration in environment variables');

const MISSING_STRAPI_CONFIG_ERROR = 'Missing Strapi configuration in environment variables';

async function fetchFromStrapiResponse(url: string) {

console.log('Fetching from Strapi...');

const strapiEndpoint = process.env.STRAPI_ENDPOINT;

const strapiApiToken = process.env.STRAPI_API_TOKEN;

if (!strapiEndpoint || !strapiApiToken) {

console.error(MISSING_STRAPI_CONFIG_ERROR);

throw new Error(MISSING_STRAPI_CONFIG_ERROR);

.changeset/true-pandas-act.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

github-actions · 2025-10-09T13:05:41Z

Branch is not up to date with base branch

@Sebastiano-Bertolin it seems this Pull Request is not updated with base branch.
Please proceed with a merge or rebase to solve this.

…ipts

github-actions · 2025-10-10T07:19:13Z

Jira Pull Request Link

This Pull Request refers to the following Jira issue DEV-2435

github-actions · 2025-10-29T03:18:30Z

This pull request is stale because it has been open for 14 days with no activity. If the pull request is still valid, please update it within 21 days to keep it open or merge it, otherwise it will be closed automatically.

Sebastiano-Bertolin added 9 commits July 7, 2025 10:54

Move scripts out of gitbook-docs package

7d444d4

Add tsconfig file

2857618

Update package.json

42df8fa

Move scripts to src directory

5ee881f

Add eslintrc file

b3f0b8a

Update package.json

9f32f64

Update dependencies package.json

8b604ef

Remove gitbook-docs package dependency

6a2fa50

Fix path to soap-api-repositories

487e9a1

Sebastiano-Bertolin requested review from a team, MarcoPonchia, marcobottaro and tommaso1 as code owners July 7, 2025 14:20

github-actions bot added packages size/small labels Jul 7, 2025

github-actions bot assigned Sebastiano-Bertolin Jul 7, 2025

marcobottaro requested changes Jul 7, 2025

View reviewed changes

packages/soap-api-data/package.json Outdated Show resolved Hide resolved

Remove dep

de35b79

marcobottaro requested changes Jul 18, 2025

View reviewed changes

packages/soap-api-data/package.json Outdated Show resolved Hide resolved

Merge branch 'main' into DEV-2435-create-new-package-for-soap-api-scr…

729da3a

…ipts

marcobottaro requested changes Jul 21, 2025

View reviewed changes

Sebastiano-Bertolin and others added 3 commits July 21, 2025 15:38

Change script name

6ca7cd0

Add changesets

b04ff5f

Merge branch 'main' into DEV-2435-create-new-package-for-soap-api-scr…

1b63229

…ipts

Sebastiano-Bertolin requested a review from marcobottaro July 21, 2025 13:40

Merge remote-tracking branch 'origin/DEV-2435-create-new-package-for-…

fe94a78

…soap-api-scripts' into DEV-2435-create-new-package-for-soap-api-scripts

github-actions bot added the changeset label Jul 21, 2025

Update script call

7905a5c

MarBert requested changes Aug 5, 2025

View reviewed changes

tommaso1 requested changes Aug 5, 2025

View reviewed changes

packages/soap-api-data/package.json Show resolved Hide resolved

github-actions bot added the stale label Aug 22, 2025

Sebastiano-Bertolin added 3 commits August 25, 2025 11:49

Merge remote-tracking branch 'origin/main' into DEV-2435-create-new-p…

da5d7fb

…ackage-for-soap-api-scripts

Fix conflicts

77f8364

Update fetchFromStrapi to manage response json

ece76aa

Sebastiano-Bertolin requested a review from tommaso1 August 25, 2025 12:13

tommaso1 requested changes Aug 26, 2025

View reviewed changes

.changeset/strong-paths-take.md Outdated Show resolved Hide resolved

packages/soap-api-data/src/helpers/fetchFromStrapi.ts Outdated Show resolved Hide resolved

packages/soap-api-data/src/helpers/fetchFromStrapi.ts Outdated Show resolved Hide resolved

github-actions bot removed the stale label Aug 29, 2025

Sebastiano-Bertolin and others added 4 commits September 11, 2025 10:38

Update .changeset/strong-paths-take.md

8511f1c

Co-authored-by: tommaso1 <tommasorosso1@gmail.com>

Update packages/soap-api-data/src/helpers/fetchFromStrapi.ts

1ef4311

Co-authored-by: tommaso1 <tommasorosso1@gmail.com>

Update packages/soap-api-data/src/helpers/fetchFromStrapi.ts

e230b2b

Co-authored-by: tommaso1 <tommasorosso1@gmail.com>

Merge branch 'main' into DEV-2435-create-new-package-for-soap-api-scr…

1567330

…ipts

Sebastiano-Bertolin requested review from MarBert and tommaso1 September 11, 2025 08:38

Coalese changesets

b1fb113

MarcoPonchia reviewed Sep 11, 2025

View reviewed changes

tommaso1 approved these changes Sep 17, 2025

View reviewed changes

Sebastiano-Bertolin and others added 3 commits September 24, 2025 10:38

Merge branch 'main' into DEV-2435-create-new-package-for-soap-api-scr…

854b3f5

…ipts

Add .env.default for soap-api-data package and exception in gitignore…

5eb5aca

… for example env files

Remove comment

52afc3e

marcobottaro requested a review from Copilot September 24, 2025 09:20

Copilot AI reviewed Sep 24, 2025

View reviewed changes

Update .changeset/true-pandas-act.md

6be1f34

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Merge branch 'main' into DEV-2435-create-new-package-for-soap-api-scr…

b1fdd0a

…ipts

github-actions bot added the stale label Oct 29, 2025

	): Promise<{ data: T[]; responseJson?: any }> {
	): Promise<{ data: T[]; responseJson?: unknown }> {

[DEV-2435] Create New Package for SOAP API scripts #1536

Are you sure you want to change the base?

[DEV-2435] Create New Package for SOAP API scripts #1536

Uh oh!

Conversation

Sebastiano-Bertolin commented Jul 7, 2025

List of Changes

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

Uh oh!

changeset-bot bot commented Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

Uh oh!

Uh oh!

marcobottaro left a comment

Choose a reason for hiding this comment

Uh oh!

MarBert left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Aug 22, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MarcoPonchia left a comment

Choose a reason for hiding this comment

Uh oh!

Sebastiano-Bertolin commented Sep 24, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Oct 9, 2025

Branch is not up to date with base branch

Uh oh!

github-actions bot commented Oct 10, 2025 • edited by atlassian bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Jira Pull Request Link

Uh oh!

github-actions bot commented Oct 29, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

changeset-bot bot commented Jul 7, 2025 •

edited

Loading

github-actions bot commented Oct 10, 2025 •

edited by atlassian bot

Loading