Merge branch 'main' into python-ruby-latest

Author: gmoigneu

.github/workflows/build-from-fork.yaml

@@ -15,7 +15,13 @@ env:
 
 jobs:
   build:
-    if: github.event.label.name == 'build-fork' || contains(github.event.pull_request.labels.*.name, 'build-fork')
+    # we only want to run this job if the pull request is from a fork AND it has been given the proper label
+    if: >-
+      (
+        github.event.label.name == 'build-fork' ||
+        contains(github.event.pull_request.labels.*.name, 'build-fork')
+      ) &&
+      github.event.pull_request.head.repo.full_name != github.repository
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -27,34 +33,21 @@ jobs:
         with:
           cli_provider: 'platform'
 
-      - name: 'checks if branch already exists'
-        id: buildthebranch
-        env:
-          PLATFORMSH_CLI_TOKEN: ${{ secrets.PLATFORMSH_CLI_TOKEN }}
-        run: |
-          buildbranch='true'
-          branchExists=$(platform project:curl /environments | jq --arg branch "${{ env.BRANCH_TITLE }}" -r '.[] | select(.name | contains($branch))');
-          if [ -n "${branchExists}" ]; then
-            # branch already exists
-            buildBranch='false'
-          fi
-
-          echo "buildBranch=${buildbranch}" >> $GITHUB_OUTPUT
       # Create an environment and activate it
       - name: 'Build a branch from the fork'
-        if: ${{ 'true'  == steps.buildthebranch.outputs.buildBranch }}
         env:
           PLATFORMSH_CLI_TOKEN: ${{ secrets.PLATFORMSH_CLI_TOKEN }}
           # @see activate_environment:Set environment title:env in manage-environment.yaml
           PR_TITLE: ${{ github.event.pull_request.title }}
         run: |
-          echo "::notice::Building branch from forked PR"
+          echo "Adding changes from forked PR to local branch"
           # Get most recent changes
           git checkout ${{ github.event.pull_request.head.sha }}
 
           # Put most recent changes on the branch
           echo "Switching to branch ${{ env.BRANCH_TITLE }}"
-          git switch -C ${{ env.BRANCH_TITLE }}
+          # try to switch to the branch, and if it doesn't exist, create a new branch
+          git switch ${{ env.BRANCH_TITLE }} 2>/dev/null || git switch -C ${{ env.BRANCH_TITLE }}
 
           echo "Pushing most recent changes"
           git push --force origin ${{ env.BRANCH_TITLE }}
@@ -77,8 +70,11 @@ jobs:
             echo "::notice::Branch ${{ env.BRANCH_TITLE }} was successfully pushed to Platform.sh. Continuing..."
           fi
 
+          # if this is an existing PR then we've already changed the title to be more descriptive, so we need id as well
+          # to match the original branch name. In addition, if it is an existing PR, then the environment will be in the
+          # process of being built and therefore will have a status of 'In progress'
           # If environment not active, activate it
-          if ! $(platform environments --format plain --columns title,status | grep '${{ env.BRANCH_TITLE }}' | grep -q Active); then
+          if ! $(platform environments --format plain --columns id,title,status | grep '${{ env.BRANCH_TITLE }}' | grep -Eq '(In progress|Active)'); then
             echo "::notice::Updating Platform.sh environment title for better tracking..."
             # in this case we DO want to statically include `pr-##` since we're referring to a pull request number
             newTitle="(pr-${{ github.event.number }}) ${PR_TITLE}"

.github/workflows/comment-on-pr.yaml

@@ -170,7 +170,7 @@ jobs:
           state: '${{ steps.set-status-message.outputs.status_state }}'
 
   report_changed_files:
-    name: Collect a list of changed files
+    name: Collects a list of changed files, reports their URL as a comment
     needs:
       - get_info_on_pr
       - get_pr_url
@@ -187,11 +187,10 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - name: Make artifact files
+      - name: Make pr_comment.txt file
         run: |
-          # these are used in comment-on-pr
-          touch pr_number.txt pr_comment.txt
-          echo "${{ env.PRNUM }}" > pr_number.txt
+          # we need this for the later action
+          touch pr_comment.txt
       - name: Get changed files
         id: changed-files
         uses: tj-actions/changed-files@v41
@@ -274,13 +273,11 @@ jobs:
         run: |
           echo -e "Your Platform.sh environment has successfully deployed. :rocket:\n\nSee the site:\n\n- [Platform.sh docs]($ENV_URL)\n- [Upsun docs]($UPSUN_ENV_URL)" > pr_comment.txt
 
-      - uses: actions/upload-artifact@v4
+      - name: Post PR comment
+        uses: marocchino/sticky-pull-request-comment@v2
         with:
-          name: pr-comment-info
-          path: |
-            pr_comment.txt
-            pr_number.txt
-          retention-days: 1
+          number: ${{ env.PRNUM }}
+          path: pr_comment.txt
 
   run-redirection-tests:
     name: Verify contracted redirections
@@ -329,10 +326,13 @@ jobs:
             # if it isn't `success` then no matter what it was it's a failure
             state="failure"
             message="Redirection verifications failed. Please see run summary."
-            # @todo do we really need a second error annotation here?
-            echo "::error::Redirection verification failed. Please see run log."
+            if [ 'skipped' = ${{ needs.run-redirection-tests.result }} ] && [ 'false' = '${{ needs.get_info_on_pr.outputs.continuetests }}' ]; then
+              message="Redirection tests can not run on forks until approved."
+            fi
           fi
 
+          echo "::warning::${message}"
+
           echo "message=${message}" >> $GITHUB_OUTPUT
           echo "state=${state}" >> $GITHUB_OUTPUT
 
@@ -405,11 +405,18 @@ jobs:
         run: |
           if [ 'success' = '${{ needs.run-e2e-test.result }}' ]; then
             message="All E2E tests passed."
+            state="success"
           else
+            state="failure"
             message="One or more E2E tests failed. See run summary."
+            if [ 'skipped' = '${{ needs.run-e2e-test.result }}' ] && [ 'false' = '${{ needs.get_info_on_pr.outputs.continuetests }}' ]; then
+              message="E2E tests can not be run on forks until approved."
+            fi
           fi
 
+          echo "::warning::${message}"
           echo "message=${message}" >> $GITHUB_OUTPUT
+          echo "state=${state}" >> $GITHUB_OUTPUT
       - name: Report matrix status
         uses: ./.github/actions/report-status
         if: always()
@@ -420,5 +427,5 @@ jobs:
           run_id: '${{ github.run_id }}'
           head_sha: '${{ needs.get_info_on_pr.outputs.headsha }}'
           status_description: '${{ steps.set-status-and-messages.outputs.message }}'
-          state: '${{ needs.run-e2e-test.result }}'
+          state: '${{ steps.set-status-and-messages.outputs.state }}'
 

.github/workflows/pr-url-and-dependent.yaml

@@ -175,8 +175,10 @@ To ensure the docs work smoothly, a few checks run on each pull request:
   ./bin/htmltest
   ```
 
-- Custom workflows [check all changed files](./.github/workflows/pr-url-and-dependent.yaml) within `docs/src`
-  and [comment with links](./.github/workflows/comment-on-pr.yaml) to the deployed pages for review.
+- Custom workflows check all changed files within `docs/src`
+  and comment with links to the deployed pages for review.
+- Checks redirection links that start with `/anchor`
+- Runs a series of end-to-end tests to ensure search is working properly
 
 Outside of pull requests, twice a week [Muffet](https://github.com/raviqqe/muffet)
 checks if all links on the site are valid.

CONTRIBUTING.md

@@ -976,6 +976,7 @@
         "3.5"
       ],
       "supported": [
+        "4.1",
         "4.0",
         "3.13",
         "3.12"

shared/data/registry.json

@@ -115,6 +115,7 @@ security:
     getenv:
     - ^GITHUB_
     - ^HUGO_HEAP_ID
+    - ^PENDO_ID
   http:
     methods:
     - GET

sites/platform/config/_default/config.yaml

@@ -40,7 +40,7 @@ To update the versions in this table, use docs/data/registry.json
 On Grid and {{% names/dedicated-gen-3 %}}, from version 2, you only specify the major version.
 The latest compatible minor version and patches are applied automatically. On Grid, version 1 represents a rolling release - the latest minor version available from the upstream (starting with opensearch 1.3).
 
-You can see the latest minor and patch versions of OpenSearch available from the [`2.x`](https://opensearch.org/lines/2x.html) and [`1.x`](https://opensearch.org/lines/1x.html) release lines.
+You can see the latest minor and patch versions of OpenSearch available from the [`2.x`](https://docs.opensearch.org/lines/2x.html) and [`1.x`](https://docs.opensearch.org/lines/1x.html) release lines.
 
 ## Deprecated versions
 

sites/platform/src/add-services/opensearch.md

@@ -221,9 +221,10 @@ For more information on project access control, see how to [manage project users
 
 ### Organization permissions
 
-As an organization owner or an organization user with the **Manage users** permission,
-you can invite other users to your organization and grant them the following permissions:
+As an organization owner or an organization user with the **Manage users** permission, you can invite other users to your organization and grant them the following permissions:
 
+- **Admin** (`owner`):
+  Manage the organization and access all organization permissions, including all listed below.
 - **Manage billing** (`billing`):
   Add, remove, and edit billing information.
   Access invoices and vouchers.

sites/platform/src/administration/users.md

@@ -122,6 +122,7 @@ security:
     getenv:
     - ^GITHUB_
     - ^HUGO_HEAP_ID
+    - ^PENDO_ID
   http:
     methods:
     - GET

sites/upsun/config/_default/config.yaml

@@ -20,7 +20,7 @@ The latest compatible minor version and patches are applied automatically.
 
 {{< image-versions image="opensearch" status="supported" environment="grid" >}}
 
-You can see the latest minor and patch versions of OpenSearch available from the [`2.x`](https://opensearch.org/lines/2x.html) and [`1.x`](https://opensearch.org/lines/1x.html) (1.3) release lines.
+You can see the latest minor and patch versions of OpenSearch available from the [`2.x`](https://docs.opensearch.org/lines/2x.html) and [`1.x`](https://docs.opensearch.org/lines/1x.html) (1.3) release lines.
 
 ## Deprecated versions
 

sites/upsun/src/add-services/opensearch.md

@@ -234,12 +234,12 @@ For more information on project access control, see how to [manage project users
 As an organization owner or an organization user with the **Manage users** permission,
 you can invite other users to your organization and grant them the following permissions:
 
+- **Admin** (`owner`):
+  Manage the organization and access all organization permissions, including all listed below.
 - **Manage billing** (`billing`):
   Add, remove, and edit billing information.
   Access invoices and vouchers.
   Users with this permission receive monthly invoices by email.
-- **Manage plans** (`plans`):
-  Access to update settings of existing projects in an organization.
 - **Manage users** (`members`):
   Add, remove, and edit organization-level users and permissions, except their own.
   Users with this permission can't grant other users permissions that they themselves don't have.

sites/upsun/src/administration/users.md

@@ -18,9 +18,14 @@ This YAML file is located in your ``.{{% vendor/cli %}}`` directory, at the root
 |   └── {{< vendor/configfile "apps" "strip" >}}
 └── <SOURCE_CODE>
 ```
-## Mandatory top-level keys
-In the ``config.yaml`` file, there are only three mandatory top-level YAML keys:
+## Top-level keys
+In the ``config.yaml`` file, there are three top-level YAML keys:
 - ``applications``: this section of the file contains all of your [app definitions](/create-apps/app-reference/single-runtime-image.md)
+
+{{% note %}}
+Note that ``applications`` is a **mandatory** top-level key to include in your ``config.yaml`` file.  
+{{% /note %}}
+
 - ``routes``: this section of the file contains all of your [route definitions](/define-routes/_index.md) (for each of your apps)
 - ``services``: this section of the file contains all of your [service definitions](/add-services/_index.md) (for each of your apps)
 
@@ -50,7 +55,7 @@ Any YAML files located at the first level of your ``.upsun`` folder, at the root
 The following rules apply to YAML files contained in the ``.upsun`` folder:
 
 - All the existing YAML files located at the first level of the ``.upsun`` folder are taken into account.
-- All the existing YAML files located at the first level of the ``.upsun`` folder must feature the [mandatory top-level keys](#mandatory-top-level-keys), and must contain a [valid YAML configuration](/create-apps/app-reference/single-runtime-image.md).
+- All the existing YAML files located at the first level of the ``.upsun`` folder must feature the [mandatory top-level keys](#top-level-keys), and must contain a [valid YAML configuration](/create-apps/app-reference/single-runtime-image.md).
 - All the YAML files in subdirectories of the ``.upsun`` folder need to be [manually imported](/learn/overview/yaml/platform-yaml-tags.md#include) and contain a [valid YAML configuration](/create-apps/app-reference/single-runtime-image.md).
 
 {{% note title="Warning" theme="warning"%}}

sites/upsun/src/learn/overview/yaml/yaml-structure.md

@@ -13,9 +13,9 @@
     <div class="grid md:grid-cols-10 divide-x-4 mt-24 print:mt-4 print:block print:mx-2"
     {{ if eq .Section "get-started" }}
       {{ if eq $.Site.Params.vendor.name "Platform.sh" }}
-      x-data="{ 
+      x-data="{
         stack: new URLSearchParams(location.search).get('stack') || 'php',
-        switchStack(targetStack) { 
+        switchStack(targetStack) {
           this.stack = targetStack
           const url = new URL(window.location.href);
 
@@ -28,7 +28,7 @@
           history.pushState(null, document.title, url.toString());
         },
         frametech: 'default',
-        switchFrametech(targetFrametech) { 
+        switchFrametech(targetFrametech) {
           this.frametech = targetFrametech;
         }
       }"
@@ -40,7 +40,7 @@
 
       <!-- Main content block -->
       <main class="md:col-span-8 xl:max-w-[120ch] xl:text-lg px-4 md:pr-0 md:pl-8 pt-4 pb-12 print:border-none print:max-w-full xl:print:max-w-full print:text-sm xl:print:text-sm">
-                
+
         {{- block "main" . }}{{- end }}
       </main>
 
@@ -57,5 +57,19 @@
     </script>
     {{ end }}
 
+    {{- $pendoid := os.Getenv "PENDO_ID" -}}
+    {{ with $pendoid }}
+    <script>
+      (function(apiKey){
+        (function(p,e,n,d,o){var v,w,x,y,z;o=p[d]=p[d]||{};o._q=o._q||[];
+          v=['initialize','identify','updateOptions','pageLoad','track'];for(w=0,x=v.length;w<x;++w)(function(m){
+            o[m]=o[m]||function(){o._q[m===v[0]?'unshift':'push']([m].concat([].slice.call(arguments,0)));};})(v[w]);
+          y=e.createElement(n);y.async=!0;y.src='https://cdn.eu.pendo.io/agent/static/'+apiKey+'/pendo.js';
+          z=e.getElementsByTagName(n)[0];z.parentNode.insertBefore(y,z);})(window,document,'script','pendo');
+        pendo.initialize({});
+      })('{{ $pendoid }}');
+    </script>
+    {{ end }}
+
   </body>
 </html>