[pull] main from platformsh:main

.github/ISSUE_TEMPLATE/new_feature.yml

@@ -0,0 +1,240 @@
+name: New feature
+description: Track product features that require new documentation
+title: "[Feature]: "
+labels: ["feature"]
+projects: ["platformsh/projects/3"]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for helping us document new features!
+  - type: textarea
+    validations:
+      required: true
+    id: description
+    attributes:
+      label: Feature details
+      description: Please include a description that can be shared publicly at this point. The DevRel team will follow-up to create a documentation sync schedule ahead of delivery.
+      placeholder: |
+        Please edit this line with a few sentences publicly describing the feature. 
+  - type: dropdown
+    id: offer
+    validations:
+      required: true
+    attributes:
+      label: Offer
+      multiple: true
+      description: What product is impacted by the feature? (select all that apply)
+      options:
+        - Platform.sh
+        - Upsun
+        - Blackfire.io
+        - DDEV
+      default: 0
+  - type: dropdown
+    id: breaking
+    validations:
+      required: true
+    attributes:
+      label: Breaking change
+      description: Does this feature introduce a breaking change?
+      options:
+        - "No"
+        - "Yes"
+      default: 0
+  # - type: dropdown
+  #   id: status
+  #   validations:
+  #     required: true
+  #   attributes:
+  #     label: Status
+  #     description: What's the current status of this feature?
+  #     options:
+  #       - "New idea"
+  #       - "Discovery"
+  #       - "Delivery"
+  #       - "Launched"
+  #     default: 0
+  # - type: dropdown
+  #   id: initiative
+  #   validations:
+  #     required: true
+  #   attributes:
+  #     label: Relevant initiative
+  #     description: Which product initiative does this feature fall under?
+  #     options:
+  #       - "Growth/Monetization"
+  #       - "Usage-based billing"
+  #       - "Self-service enablement"
+  #       - "User management"
+  #       - "Observability"
+  #       - "Horizontal PaaS"
+  #       - "Vendorization"
+  #     default: 0
+  - type: dropdown
+    id: observability_domain
+    attributes:
+      label: Observability domain
+      multiple: true
+      description: Observability domain (If applicable, select all that apply)
+      options:
+        - Profiling
+        - Tracing
+        - Log Management
+        - Metrics
+        - Governance & compliance
+        - Real-User Monitoring
+        - Troubleshooting
+      default: 0
+  - type: dropdown
+    id: component_impact
+    attributes:
+      label: DX impact
+      multiple: true
+      description: Where will users encounter the feature? (select all that apply)
+      options:
+        - API
+        - Configuration schema changes
+        - CLI
+        - Console
+        - Blackfire.io dashboard
+        - Blackfire.io player
+        - Blackfire.io CLI
+        - DDEV CLI
+      default: 0
+  - type: dropdown
+    id: request_type
+    validations:
+      required: true
+    attributes:
+      label: Docs requirements
+      description: Does this feature require new docs/sections, adjustments to existing docs, or both?
+      options:
+        - "The feature makes changes to existing docs pages."
+        - "There will need to be new pages or sections written."
+        - "This feature changes behavior or recommended use considerably, and should likely have docs-wide consequences."
+        - "Not sure. TBD"
+      default: 0
+  - type: dropdown
+    id: docs_impact
+    attributes:
+      multiple: true
+      label: Docs impact
+      description: Which areas of the documentation will be (or should be, in your mind) impacted by the feature?
+      options:
+        - "(Platform.sh/Upsun) Getting started materials or framework-specfic guides"
+        - "(Platform.sh/Upsun) Learn: tutorials & best practices"
+        - "(Platform.sh/Upsun) Reference > Configuration > Apps"
+        - "(Platform.sh/Upsun) Reference > Configuration > Services"
+        - "(Platform.sh/Upsun) Reference > Configuration > Routes"
+        - "(Platform.sh/Upsun) Reference > Configuration > Runtime languages"
+        - "(Platform.sh/Upsun) Reference > Integrations"
+        - "(Platform.sh/Upsun) Reference > Observability"
+        - "(Platform.sh/Upsun) Reference > Managing projects/environments"
+        - "(Platform.sh/Upsun) Reference > Domains"
+        - "(Platform.sh/Upsun) Reference > Administration"
+        - "(Platform.sh/Upsun) Reference > Security"
+        - "(Platform.sh/Upsun) Reference > Development"
+        - "(Platform.sh) Reference > Dedicated 2/3"
+        - "(Upsun) Reference > Manage resources"
+        - "(Blackfire) Introduction"
+        - "PHP"
+        - "Python"
+        - "Profile"
+        - "Monitor"
+        - "Test"
+        - "Build"
+        - "Integrate"
+        - "Reference guide"
+      default: 0
+  - type: dropdown
+    id: other_requirements
+    validations:
+      required: true
+    attributes:
+      multiple: true
+      label: Additional requirements
+      description: Are there other requirements of the feature the DevRel team should know about? (select all that apply)
+      options:
+        - "Screenshots will be needed."
+        # - "A video demo would be helpful."
+        - "Testing is needed."
+        - "Not sure. TBD"
+      default: 0
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem
+      description: What's being solved by this feature?
+      value: TBD
+  - type: textarea
+    id: crud_config
+    attributes:
+      label: CRUD and/or schema
+      description: How is the feature configured, enabled, disabled, and updated? 
+      value: TBD
+  - type: textarea
+    id: bc_breaking
+    attributes:
+      label: Backwards compatibility & breaking changes
+      description: Please include any relevant details related to BC and breaking changes.
+      value: TBD
+
+
+  # - type: checkboxes
+  #   attributes:
+  #     label: Does this introduce a breaking change?
+  #     description: Please search to see if an issue already exists for the bug you encountered.
+  #     options:
+  #     - label: I have searched the existing issues
+  #       required: true
+  # - type: input
+  #   id: contact
+  #   attributes:
+  #     label: Contact Details
+  #     description: How can we get in touch with you if we need more info?
+  #     placeholder: ex. [email protected]
+  #   validations:
+  #     required: false
+  # - type: textarea
+  #   id: what-happened
+  #   attributes:
+  #     label: What happened?
+  #     description: Also tell us, what did you expect to happen?
+  #     placeholder: Tell us what you see!
+  #     value: "A bug happened!"
+  #   validations:
+  #     required: true
+  # - type: dropdown
+  #   id: version
+  #   attributes:
+  #     label: Version
+  #     description: What version of our software are you running?
+  #     options:
+  #       - 1.0.2 (Default)
+  #       - 1.0.3 (Edge)
+  #     default: 0
+  #   validations:
+  #     required: true
+  # - type: dropdown
+  #   id: browsers
+  #   attributes:
+  #     label: What browsers are you seeing the problem on?
+  #     multiple: true
+  #     options:
+  #       - Firefox
+  #       - Chrome
+  #       - Safari
+  #       - Microsoft Edge
+
+
+
+  # - type: checkboxes
+  #   id: terms
+  #   attributes:
+  #     label: Code of Conduct
+  #     description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
+  #     options:
+  #       - label: I agree to follow this project's Code of Conduct
+  #         required: true

.github/actions/get-pr-info/action.yaml

@@ -0,0 +1,90 @@
+name: Get PR URL
+description: Checks the status of the environment based on branch, returns environment URL
+inputs:
+  platformsh_token:
+    description: 'Platform.sh/Upsun.com API token'
+    required: true
+  branch:
+    description: 'Branch name we should watch for deployment'
+    required: true
+
+####
+outputs:
+  env_status:
+    description: "Final status of the PR environment"
+    value: ${{ steps.get_env_url.outputs.env_status }}
+  pr_url:
+    description: "The URL of the PR environment"
+    value: ${{ steps.get_env_url.outputs.env_url }}
+  pr_url_upsun:
+    description: "The URL of the Upsun variant of the PR environment"
+    value: ${{ steps.get_env_url.outputs.env_url_upsun }}
+
+
+runs:
+  using: composite
+  steps:
+    - name: Set up Platform.sh CLI
+      env:
+        PLATFORMSH_CLI_TOKEN: ${{ inputs.platformsh_token }}
+      uses: ./.github/actions/set-up-cli
+    - name: Get environment URL
+      shell: bash
+      env:
+        PLATFORMSH_CLI_TOKEN: ${{ inputs.platformsh_token }}
+        BRANCH: ${{ inputs.branch }}
+        UPSUN_DOCS_PREFIX: "https://docs.upsun.com" # @todo move to a repo var?
+      id: get_env_url
+      run: |
+        COMMIT_STATUS="pending"
+
+        # Get the state of the most recent deployment activity
+        # run commands in workflows are are automatically launched with shell: /usr/bin/bash -e {0}. If for some
+        # reason the psh cli errors (e.g. branch hasn't reached psh and therefore doesnt exist, api times out, etc)
+        # this will cause our workflow to exit. Instead, call the cli with an | true so we can attempt to query again
+        STATE=$(platform activities --format plain --type "environment.push environment.activate environment.redeploy environment.branch" --no-header --columns "state" --limit 1 --environment ${BRANCH} || true)
+        echo "::notice::Attempting to retrieve deployed environment URL. Current state is: ${STATE}"
+        # Set tries to 0 to start countdown to timeout
+        STATUS_TRY=1
+        # We'll try up to 20 minutes, so (SLEEP_TIME*NUM_ATTEMPTS)/60 = 10*
+        SLEEP_TIME=10
+        NUM_ATTEMPTS=120
+
+        # Wait until state is complete or 20 minutes has passed
+        until [ "${STATE}" = "complete" ] || [ ${STATUS_TRY} = ${NUM_ATTEMPTS} ]; do
+          sleep ${SLEEP_TIME}
+          echo "::notice::Environment is not deployed. Attempting to retrieve deployed status. Attempt ${STATUS_TRY} of ${NUM_ATTEMPTS}."
+          STATE=$(platform activities --format plain --type "environment.push environment.activate environment.redeploy environment.branch" --no-header --columns "state" --limit 1 --environment "${BRANCH}" || true)
+          echo "::notice::Status retrieved: ${STATE}"
+
+          if [ "${STATE}" = "complete" ]; then
+            echo "::notice::Activity is complete."
+          fi
+
+          # we want to clear the cli cache every 3rd attempt in case it is caching too heavily
+          if [ $(expr ${STATUS_TRY} % 3) = 0 ]; then
+            echo "Clearing the cli cache..."
+            platform clear-cache
+          fi
+
+          STATUS_TRY=$((++STATUS_TRY))
+        done
+
+        # Get the URL of the environment
+        ENV_URL=$(platform url --primary --pipe --environment "${BRANCH}")
+
+        # Get the status of the build activity
+        COMMIT_STATUS=$(platform activities --format plain --type "environment.push environment.activate environment.redeploy environment.branch" --no-header --columns "result" --limit 1 --environment "${BRANCH}")
+
+        # Report findings
+        echo "The Platform.sh environment is:"
+        echo "$COMMIT_STATUS"
+        if [ "$COMMIT_STATUS" = "success" ]; then
+          echo "Environment deployed to:"
+          echo "$ENV_URL"
+        fi
+
+        # Report the final statuses to be used in future jobs
+        echo "env_status=$COMMIT_STATUS" >> $GITHUB_OUTPUT
+        echo "env_url=$ENV_URL" >> $GITHUB_OUTPUT
+        echo "env_url_upsun=${{ env.UPSUN_DOCS_PREFIX }}.${ENV_URL:8}" >> $GITHUB_OUTPUT

.github/actions/redirection-verification/action.yaml

@@ -0,0 +1,22 @@
+name: redirections contract verification
+description: Verifies that the redirections for our contract with console are still valid
+inputs:
+  environment-url:
+    description: 'Pull Request Environment URL'
+    required: true
+  number_retries:
+    description: 'The number of attempts we should make to contact the target environment URL.'
+    required: false
+    default: '100'
+  retry_sleep:
+    description: 'The length of time (in ms) to pause between each attempt at trying the redirect.'
+    required: false
+    default: '1000'
+
+####
+#outputs:
+####
+
+runs:
+  using: 'node20'
+  main: index.js