diff --git a/.github/workflows/coverage_comment.yml b/.github/workflows/coverage_comment.yml index 8ddd29c1ce6..9c395dd244d 100644 --- a/.github/workflows/coverage_comment.yml +++ b/.github/workflows/coverage_comment.yml @@ -11,6 +11,7 @@ permissions: jobs: comment: + if: ${{ github.event.workflow_run.conclusion == 'success' }} runs-on: ubuntu-latest steps: diff --git a/docker-compose.yml b/docker-compose.yml index 36bbe54ef43..ced361320f6 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -117,10 +117,14 @@ services: <<: *default-env MANAGER_OAUTH: ${MANAGER_OAUTH} - # Cypress test runner service to run tests against a locally-served Cloud instance. + # Cypress test runner service to run tests against a local Cloud instance. # - # This is useful when testing against a customized or in-development build of - # Cloud Manager. + # This is useful when testing against a Cloud Manager instance served locally at + # `localhost:3000`, e.g. during development. + # + # If the local Cloud Manager instance is not served at `localhost:3000` (when + # served from a container, for example), prefer the `cypress_containerized` + # service instead. cypress_local: <<: *default-runner environment: @@ -130,6 +134,38 @@ services: web: condition: service_healthy + # Cypress test runner service to run tests against a containerized Cloud instance. + # + # This service reverse proxies the given $CYPRESS_BASE_URL to `localhost:3000`. + # This is necessary for certain tests which require a secure context, which + # can typically only be achieved when Cloud is served at `localhost` or + # remotely behind SSL. + # + # For more information, refer to: + # https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts + # + # If the local Cloud Manager instance is served at `localhost:3000` (when + # running Cloud Manager locally during development, for example), prefer the + # `cypress_local` service instead. + cypress_containerized: + <<: *default-runner + build: + context: . + dockerfile: ./packages/manager/Dockerfile + target: e2e-reverse-proxy + environment: + <<: *default-env + MANAGER_OAUTH: ${MANAGER_OAUTH} + CYPRESS_BASE_URL: "http://localhost:3000" + REVERSE_PROXY_URL: ${CYPRESS_BASE_URL} + depends_on: + web: + condition: service_healthy + entrypoint: + - "/bin/sh" + - "-c" + - "caddy reverse-proxy --from $${CYPRESS_BASE_URL} --to $${REVERSE_PROXY_URL} & yarn $0 $@" + # Cypress component test runner service. # # Unlike other Cloud Manager Cypress tests, these tests can be run without diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index cbf69499d81..c64ee516fe9 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -27,7 +27,8 @@ Feel free to open an issue to report a bug or request a feature. **Example:** `feat: [M3-1234] - Allow user to view their login history` 6. Open a pull request against `develop` and make sure the title follows the same format as the commit message. -7. If needed, create a changeset to populate our changelog. +7. Keep in mind that our repository is public and open source! Before adding screenshots to your PR, we recommend you enable the **Mask Sensitive Data** setting in Cloud Manager [Profile Settings](https://cloud.linode.com/profile/settings). +8. If needed, create a changeset to populate our changelog. - If you don't have the Github CLI installed or need to update it (you need GH CLI 2.21.0 or greater), - install it via `brew`: https://github.com/cli/cli#installation or upgrade with `brew upgrade gh` - Once installed, run `gh repo set-default` and pick `linode/manager` (only > 2.21.0) diff --git a/docs/PULL_REQUEST_TEMPLATE.md b/docs/PULL_REQUEST_TEMPLATE.md index 15e72c8495e..01333bdab73 100644 --- a/docs/PULL_REQUEST_TEMPLATE.md +++ b/docs/PULL_REQUEST_TEMPLATE.md @@ -10,7 +10,9 @@ List any change relevant to the reviewer. Please specify a release date to guarantee timely review of this PR. If exact date is not known, please approximate and update it as needed. ## Preview 📷 -**Include a screenshot or screen recording of the change** +**Include a screenshot or screen recording of the change.** + +:lock: Use the [Mask Sensitive Data](https://cloud.linode.com/profile/settings) setting for security. :bulb: Use `