Shopify / checkout-sheet-kit-react-native

Shopify's Checkout Sheet Kit for React Native - simplifying the process of adding checkout to your native apps.
https://shopify.dev/docs/custom-storefronts/mobile-apps
MIT License
35 stars 5 forks source link

Improve contribution docs #34

Closed markmur closed 11 months ago

markmur commented 11 months ago

What are you trying to accomplish?

Improves the contribution docs

Before you deploy

caution-tape-bot[bot] commented 11 months ago

:wave: It seems that this PR is adding a GitHub Action workflow that looks a lot like a CI step.

If your repository is a prodkit repository, then this is fine. Please ignore the rest of this comment.

If your repository already uses Shopify Build CI or Shipit CD, then please make sure to consider whether you are splitting your CI/CD pipelines and jobs in a way that makes sense and is easy to maintain.

If this workflow change is not introducing a CI step, then feel free to ignore this comment.

For more details and explanation, click to expand... Shopify Build used to be the required platform for CI at Shopify, but we are now allowing GitHub Actions to be used for this purpose, especially if the repo is using ProdKit for deploys. But it's not always a good idea to split your CI for a repo or service between different systems at once. We want to make sure that developers think about the potential maintenance costs of maintaining multiple systems before doing so. For more information, see [GitHub Actions](https://vault.shopify.io/page/GitHub-Actions~dhbdb57.md#user-content--changes-to-rules-around-ci-and-cd-in-github-actions-) on Vault. Note that this message is based on a simple [regex detection](https://github.com/Shopify/services-db/blob/master/components/caution_tape_bot/app/models/caution_tape_bot/rules/github_actions.rb#L68), and may not always be accurate. If your action is not a CI step, and is already running on `shopify-ubuntu-latest` or similar, feel free to ignore this message. If your repository is intended to become Public later, please use `runs-on: shopify-ubuntu-latest` for now and ignore the rest of this comment. Though if you need to use Ubuntu 20.04 only, you would need to use `runs-on: shopify-ubuntu-20.04`. Or `runs-on: shopify-ubuntu-latest-2` for Ubuntu 22.04.

This comment was added by the GitHubActions::CiStep Caution Tape Bot rule. _View the source of this rule in Services DB_