Merge branch 'main' into fix/run-processing

Author: millotp

.github/workflows/check.yml

@@ -319,6 +319,8 @@ jobs:
       ALGOLIA_APPLICATION_ID: ${{ secrets.ALGOLIA_APPLICATION_ID }}
       ALGOLIA_ADMIN_KEY: ${{ secrets.ALGOLIA_ADMIN_KEY }}
       MONITORING_API_KEY: ${{ secrets.MONITORING_API_KEY }}
+    outputs:
+      hasBreakingChanges: ${{ steps.breakingChanges.outputs.hasBreakingChanges }}
     name: client ${{ matrix.client.language }}@${{ matrix.client.version }}
     steps:
       - uses: actions/checkout@v4
@@ -355,7 +357,8 @@ jobs:
         run: yarn cli build playground ${{ matrix.client.language }}
 
       - name: Run Java 'algoliasearch' public API validation
-        if: ${{ github.base_ref == 'main' && matrix.client.language == 'java' && matrix.client.isMainVersion && !contains(format('{0} {1}', github.event.pull_request.title, github.event.head_commit.message), '[skip-bc]') }}
+        id: breakingChanges
+        if: ${{ github.base_ref == 'main' && matrix.client.language == 'java' && matrix.client.isMainVersion }}
         run: |
           cd ${{ matrix.client.path }}
           exit_code=0
@@ -367,7 +370,9 @@ jobs:
             cat $FILE
           fi
 
-          exit $exit_code
+          if [[ $exit_code -ne 0 ]]; then
+            echo "hasBreakingChanges=true" >> $GITHUB_OUTPUT
+          fi
 
       - name: Remove previous CTS output
         run: rm -rf ${{ matrix.client.testsToDelete }} || true
@@ -431,7 +436,7 @@ jobs:
       !contains(needs.*.result, 'failure')
     outputs:
       success: ${{ steps.setoutput.outputs.success }}
-    name: client kotlin${{ needs.setup.outputs.RUN_MACOS_KOTLIN_BUILD == 'true' && format('@{0}', fromJSON(needs.setup.outputs.KOTLIN_DATA).version) || '' }} macos
+    name: client kotlin${{ format('@{0}', fromJSON(needs.setup.outputs.KOTLIN_DATA).version) }} macos
     steps:
       - uses: actions/checkout@v4
 
@@ -481,7 +486,7 @@ jobs:
       MONITORING_API_KEY: ${{ secrets.MONITORING_API_KEY }}
     outputs:
       success: ${{ steps.setoutput.outputs.success }}
-    name: client swift${{ needs.setup.outputs.RUN_MACOS_SWIFT_CTS == 'true' && format('@{0}', fromJSON(needs.setup.outputs.SWIFT_DATA).version) || '' }} macos
+    name: client swift${{ format('@{0}', fromJSON(needs.setup.outputs.SWIFT_DATA).version) }} macos
     steps:
       - uses: actions/checkout@v4
         if: ${{ env.ALGOLIA_APPLICATION_ID != '' }}
@@ -586,12 +591,25 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.ALGOLIA_BOT_TOKEN != '' && secrets.ALGOLIA_BOT_TOKEN || secrets.GITHUB_TOKEN }}
           PR_NUMBER: ${{ github.event.number }}
 
+      - name: Check for breaking changes
+        id: breakingChanges
+        if: ${{ needs.client_gen.outputs.hasBreakingChanges == 'true' }}
+        run: |
+          {
+            echo 'BREAKING_CHANGES_SECTION<<EOF'
+            echo "# 💥 Breaking changes detected !!"
+            echo "Either this PR or a previous PR not released yet introduced breaking changes, be careful when merging."
+            echo "You can find the details in the 'client java@17' CI job."
+            echo 'EOF'
+          } >> "$GITHUB_OUTPUT"
+
       - name: update generation comment
         uses: marocchino/sticky-pull-request-comment@v2
         if: ${{ steps.pushGeneratedCode.outputs.GENERATED_COMMIT == '' }}
         with:
           GITHUB_TOKEN: ${{ secrets.ALGOLIA_BOT_TOKEN != '' && secrets.ALGOLIA_BOT_TOKEN || secrets.GITHUB_TOKEN }}
           message: |
+            ${{ steps.breakingChanges.outputs.BREAKING_CHANGES_SECTION }}
             ### No code generated
 
             _If you believe code should've been generated, please, [report the issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=bug%2Ctriage&projects=&template=Bug_report.yml&title=%5Bbug%5D%3A+)._
@@ -604,6 +622,7 @@ jobs:
         with:
           GITHUB_TOKEN: ${{ secrets.ALGOLIA_BOT_TOKEN != '' && secrets.ALGOLIA_BOT_TOKEN || secrets.GITHUB_TOKEN }}
           message: |
+            ${{ steps.breakingChanges.outputs.BREAKING_CHANGES_SECTION }}
             ### ✔️ Code generated!
 
             |  Name | Link |

scripts/cli/index.ts

@@ -303,14 +303,12 @@ program
   )
   .option('-d, --dry-run', 'does not push anything to GitHub')
   .option('-vh, --versions-history', 'only generates the versions-history policy', false)
-  .option('-b --breaking', 'allow breaking change on the CI', false)
-  .action(async ({ verbose, releaseType, dryRun, versionsHistory, breaking }) => {
+  .action(async ({ verbose, releaseType, dryRun, versionsHistory }) => {
     setVerbose(Boolean(verbose));
 
     await createReleasePR({
       releaseType,
       dryRun,
-      breaking,
       versionsHistory,
     });
   });

scripts/release/createReleasePR.ts

@@ -341,12 +341,10 @@ async function prepareGitEnvironment(dryRun: boolean): Promise<void> {
 export async function createReleasePR({
   releaseType,
   dryRun,
-  breaking,
   versionsHistory,
 }: {
   releaseType?: semver.ReleaseType;
   dryRun?: boolean;
-  breaking?: boolean;
   versionsHistory?: boolean;
 }): Promise<void> {
   await prepareGitEnvironment(dryRun || versionsHistory || false);
@@ -418,7 +416,7 @@ export async function createReleasePR({
 
   setVerbose(true);
   console.log(`Pushing updated changes to: ${headBranch}`);
-  const commitMessage = `${generationCommitText.commitPrepareReleaseMessage}${breaking ? ' [skip-bc]' : ''}`;
+  const commitMessage = generationCommitText.commitPrepareReleaseMessage;
   await run('git add .');
   await run(`CI=true git commit -m "${commitMessage}"`);
 

specs/analytics/common/parameters.yml

@@ -76,10 +76,7 @@ ClickAnalytics:
 RevenueAnalytics:
   in: query
   name: revenueAnalytics
-  description: |
-    Whether to include revenue-related metrics in the response.
-
-    If true, metrics related to click and conversion events are also included in the response.
+  description: Whether to include metrics related to revenue events in the response.
   schema:
     type: boolean
     default: false
@@ -184,7 +181,7 @@ clickThroughRate:
   type: number
   format: double
   description: |
-    Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches.
+    Click-through rate: calculated as the number of tracked searches with at least one click event divided by the number of tracked searches.
     If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
   nullable: true
   minimum: 0
@@ -195,15 +192,17 @@ clickThroughRate:
 noClickRate:
   type: number
   format: double
-  description: No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
+  description: |
+    No click rate: calculated as the number of tracked searches without clicks divided by the number of tracked searches.
   minimum: 0
   maximum: 1
   example: 0.15
 
 noResultsRate:
   type: number
   format: double
-  description: No results rate, calculated as number of searches with zero results divided by the total number of searches.
+  description: |
+    No results rate: calculated as the number of searches with zero results divided by the total number of searches.
   minimum: 0
   maximum: 1
   example: 0.49
@@ -212,7 +211,7 @@ conversionRate:
   type: number
   format: double
   description: |
-    Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches.
+    Conversion rate: calculated as the number of tracked searches with at least one conversion event divided by the number of tracked searches.
     If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
   nullable: true
   minimum: 0
@@ -231,7 +230,7 @@ addToCartRate:
   type: number
   format: double
   description: |
-    Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches.
+    Add-to-cart rate: calculated as the number of tracked searches with at least one add-to-cart event divided by the number of tracked searches.
     If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
   nullable: true
   minimum: 0
@@ -250,7 +249,7 @@ purchaseRate:
   type: number
   format: double
   description: |
-    Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches.
+    Purchase rate: calculated as the number of tracked searches with at least one purchase event divided by the number of tracked searches.
     If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
   nullable: true
   minimum: 0
@@ -266,7 +265,8 @@ purchaseCount:
 
 currencies:
   type: object
-  description: Revenue associated with this search, broken-down by currencies.
+  description: |
+    Revenue associated with this search: broken down by currency.
   default: {}
   additionalProperties:
     title: currencyCode
@@ -310,7 +310,7 @@ search:
   type: string
 
 hit:
-  description: Object ID of a record that's returned as a search result.
+  description: Object ID of a record returned as a search result.
   type: string
   example: 'method-export-rules-php'
 

specs/analytics/common/schemas/getTopFiltersNoResults.yml

@@ -9,7 +9,7 @@ getTopFiltersNoResultsResponse:
       nullable: true
       description: |
         Filters for searches without any results.
-        If null, the search term specified with the `search` parameter is not a search without results,
+        If null, the search term specified with the `search` parameter isn't a search without results,
         or the `search` parameter is absent from the request.
       items:
         $ref: '#/getTopFiltersNoResultsValues'

specs/analytics/paths/click/getAddToCartRate.yml

@@ -6,9 +6,18 @@ get:
     - analytics
   summary: Retrieve add-to-cart rate
   description: |
-    Retrieves the add-to-cart rate for all of your searches with at least one add-to-cart event, including a daily breakdown.
+    Retrieves the add-to-cart rate for all your searches with at least one add-to-cart event, including a daily breakdown.
 
     By default, the analyzed period includes the last eight days including the current day.
+
+    The rate is the number of add-to-cart conversion events divided by the number of tracked searches.
+    A search is tracked if it returns a queryID (`clickAnalytics` is `true`).
+    This differs from the response's `count`, which shows the overall number of searches, including those where `clickAnalytics` is `false`.
+
+    **There's a difference between a 0 and null add-to-cart rate when `clickAnalytics` is enabled:**
+
+    - **Null** means there were no queries: since Algolia didn't receive any events, the add-to-cart rate is null.
+    - **0** mean there _were_ queries but no [add-to-cart events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received.
   parameters:
     - $ref: '../../../common/parameters.yml#/Index'
     - $ref: '../../../common/parameters.yml#/StartDate'

specs/analytics/paths/click/getAverageClickPosition.yml

@@ -8,9 +8,12 @@ get:
   description: |
     Retrieves the average click position of your search results, including a daily breakdown.
 
-    The average click position is the average of all clicked search results' positions.
+    The average click position is the average of all clicked search result positions.
     For example, if users only ever click on the first result for any search, the average click position is 1.
     By default, the analyzed period includes the last eight days including the current day.
+
+    An average of `null` when `clickAnalytics` is enabled means Algolia didn't receive any [click events](https://www.algolia.com/doc/guides/sending-events/getting-started/) for the queries.
+    The average is `null` until Algolia receives at least one click event.
   parameters:
     - $ref: '../../../common/parameters.yml#/Index'
     - $ref: '../../../common/parameters.yml#/StartDate'

specs/analytics/paths/click/getClickPositions.yml

@@ -9,6 +9,8 @@ get:
     Retrieves the positions in the search results and their associated number of clicks.
 
     This lets you check how many clicks the first, second, or tenth search results receive.
+
+    An average of `0` when `clickAnalytics` is enabled means Algolia didn't receive any [click events](https://www.algolia.com/doc/guides/sending-events/getting-started/) for the queries.
   parameters:
     - $ref: '../../../common/parameters.yml#/Index'
     - $ref: '../../../common/parameters.yml#/StartDate'

specs/analytics/paths/click/getClickThroughRate.yml

@@ -6,9 +6,14 @@ get:
     - analytics
   summary: Retrieve click-through rate
   description: |
-    Retrieves the click-through rate for all of your searches with at least one click event, including a daily breakdown
+    Retrieves the click-through rate (CTR) for all your searches with at least one click event, including a daily breakdown.
 
     By default, the analyzed period includes the last eight days including the current day.
+
+    **There's a difference between a 0 and null CTR when `clickAnalytics` is enabled:**
+
+    - **Null** means there were no queries: since Algolia didn't receive any events, CTR is null.
+    - **0** mean there _were_ queries but no [click events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received.
   parameters:
     - $ref: '../../../common/parameters.yml#/Index'
     - $ref: '../../../common/parameters.yml#/StartDate'

specs/analytics/paths/click/getConversionRate.yml

@@ -6,9 +6,14 @@ get:
     - analytics
   summary: Retrieve conversion rate
   description: |
-    Retrieves the conversion rate for all of your searches with at least one conversion event, including a daily breakdown.
+    Retrieves the conversion rate (CR) for all your searches with at least one conversion event, including a daily breakdown.
 
     By default, the analyzed period includes the last eight days including the current day.
+
+    **There's a difference between a 0 and null CR when `clickAnalytics` is enabled:**
+
+    - **Null** means there were no queries: since Algolia didn't receive any events, CR is null.
+    - **0** mean there _were_ queries but no [conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received.
   parameters:
     - $ref: '../../../common/parameters.yml#/Index'
     - $ref: '../../../common/parameters.yml#/StartDate'