[pull] main from platformsh:main

.github/ISSUE_TEMPLATE/config.yml

@@ -1 +1,8 @@
 blank_issues_enabled: false # Force people to start from a template
+contact_links:
+  - name: "Upsun Support - open a Support ticket" 
+    url: https://console.upsun.com/-/users/~/tickets/open
+    about: If you're experiencing problems with the Upsun Flex or Fixed product offerings, please open a Support ticket.
+  - name: "Upsun Community Forum - questions and messages"
+    url: https://community.upsun.com
+    about: For questions and discussion about Upsun Flex or Upsun Fixed product offerings, reach out on the Upsun Community Forum!

.github/ISSUE_TEMPLATE/improvements.yml

@@ -1,35 +1,49 @@
-name: Improvements
-description: For changes to improve existing content.
+name: 'Docs - Improvements and corrections'
+description: Suggest changes to improve or correct the existing Upsun Flex or Fixed content
 labels:
   - ungroomed
 body:
   - type: markdown
     attributes:
       value: |
-        Thanks for your interest in helping improve the Platform.sh docs!
-        Please fill in the fields below so we can understand what changes are needed.
+        Please complete the fields below to help us improve the Upsun docs.
+  - type: dropdown
+    id: priority
+    validations:
+      required: true
+    attributes:
+      label: Priority
+      description: How urgent is this update?
+      options:
+        - 1 - Urgent - customers are affected; causes support issues
+        - 2 - Important - inaccurate info needs to be corrected to prevent customer issues
+        - 3 - Not urgent - can be addressed as team bandwidth permits
+        - 4 - Nice-to-have - ideal, but not mandatory
+        - 5 - Unsure - Docs/Advocacy team will assess 
+      default: 2
 
   - type: textarea
     attributes:
-      label: Where on docs.platform.sh should be changed?
-      description: Link to the pages you think should be updated.
-      placeholder: https://docs.platform.sh/
+      label: Where should the changes be made?
+      description: Add the links to the Upsun Flex and/or Upsun Fixed pages you think should be updated.
+      placeholder: https://docs.upsun.com, https://fixed.docs.upsun.com/
     validations:
       required: true
 
   - type: textarea
     attributes:
       label: What exactly should be updated?
       description: |
-        - Share as much detail as you can to help us understand the suggestion. 
-        - What is written now that shouldn't be or isn't written that should be?
-        - What do you expect as an outcome?
+        - **Do not** include Upsun-internal information, Slack threads, etc. in this field.
+        - What needs to be added, removed, or updated? Please provide as much detail as possible. 
+        - Include expected outcomes that users will find useful. 
+        - Include additional guidance that prevent unexpected outcomes for users.
     validations:
       required: true
 
   - type: textarea
     attributes:
-      label: Additional context
-      description: Optionally add any other information or screenshots that could help us understand and implement the change.
+      label: 'Optional: Additional context'
+      description: Include other information or screenshots that could help us understand and implement the change.
     validations:
       required: false

.github/ISSUE_TEMPLATE/new_docs.yml

@@ -1,26 +1,69 @@
-name: New docs
-description: For adding documentation that doesn't yet exist, such as for a new feature.
+name: 'Docs - New documentation request'
+description: Propose new documentation (new features, new guides, etc.)
 labels:
   - ungroomed
 body:
   - type: markdown
     attributes:
       value: |
-        Thanks for helping improve the Platform.sh docs!
-        Please fill in the fields below so we can understand what documentation is needed.
+        Please complete the fields below to help us improve the Upsun docs.
+
+  - type: dropdown
+    id: offering
+    validations:
+      required: true
+    attributes:
+      label: Offering
+      multiple: true
+      description: Which offering is impacted by the feature? (select all that apply)
+      options:
+        - Upsun Flex
+        - Upsun Fixed
+      default: 0,1
 
   - type: textarea
     attributes:
       label: What needs to be documented?
       description: |
-        Describe in detail what is missing from the documentation.
-        Include the use case for the missing feature: why people want to use it.
+        - **Do not** include Upsun-internal information, Slack threads, etc. in this field.
+        - Include information such as key use cases, benefits to the user, business problem solved, etc.
+        - Include expected outcomes that users will find useful. 
+        - Include guidance that will prevent negative or unexpected outcomes for users.
     validations:
       required: true
 
+  - type: dropdown
+    id: docs_impact
+    attributes:
+      multiple: true
+      label: Docs impact
+      description: Where do you believe these docs should be placed? For further comments, use the Additional context field later in this form.
+      options:
+        - "Get started materials or framework-specific guides"
+        - "Learn: tutorials & best practices"
+        - "Frameworks (Fixed only)"
+        - "Reference > Configure apps"
+        - "Reference > Add services"
+        - "Reference > Define routes"
+        - "Reference > Languages"
+        - "Reference > Development"
+        - "Reference > Integrations"
+        - "Reference > Increase observability"
+        - "Reference > Managing manage enviornments/projects"
+        - "Reference > Custom domains"
+        - "Reference > Administration"
+        - "Reference > Security and compliance"
+        - "Reference > Dedicated 2 (Fixed only)"
+        - "Reference > Manage resources (Flex only)"
+        - "Reference > Glossary"
+      default: 0
+    validations:
+      required: false
+
   - type: textarea
     attributes:
-      label: Additional context
-      description: Optionally add any other information or screenshots that could help us understand what to document.
+      label: 'Optional: Additional context'  
+      description: Include other information or screenshots that could help us understand and implement the change.
     validations:
       required: false
+

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

@@ -0,0 +1,107 @@
+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
+  project:
+    description: 'project id'
+    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
+      # temporary usage until the official is public
+      uses: upsun/action-cli@v1
+      with:
+          cli_provider: 'platform'
+    - 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 "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 "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
+
+        # status is complete, check result
+        RESULT=$(platform activities --format plain --type "environment.push environment.activate environment.redeploy environment.branch" --no-header --columns "result" --limit 1 --environment "${BRANCH}" || true)
+
+        if [ "failure" = "${RESULT}" ]; then
+          FAILEDID=$(platform activities --format plain --type "environment.push environment.activate environment.redeploy environment.branch" --no-header --columns "ID" --limit 1 --environment "${BRANCH}")
+          LOGLINES=$(platform activity:log "${FAILEDID}" --environment "${BRANCH}" --quiet | tail -n 20)
+          echo "::error title=Build failed::Build of environment ${BRANCH} failed!"
+          echo "::group::Last 20 lines from deploy log"
+          echo "${LOGLINES}"
+          echo "::endgroup::"
+          exit 1
+        fi
+
+        # 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,31 @@
+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
+  base_environment_url:
+    description: 'aka value of {default}'
+    required: true
+  redirection_token:
+    description: 'Redirectionio API token'
+    required: true
+  redirection_project_id:
+    description: 'The organization id that manages the redirection rules'
+    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