From ec16bd4d3df380353866ff9ca2f720dcc31c756e Mon Sep 17 00:00:00 2001 From: othomson-roblox <64273528+othomson-roblox@users.noreply.github.com> Date: Wed, 4 Sep 2024 16:10:38 -0700 Subject: [PATCH] Update README.md --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0d2c78d..4919401 100644 --- a/README.md +++ b/README.md @@ -23,11 +23,10 @@ A special thanks is given to the creators of Rojo, Selene and StyLua for creatin - `universe.places:write` - `universe.place.luau-execution-session:write` 3. Save this API key as a [GitHub Actions Secret](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions) named `ROBLOX_API_KEY` -4. Create G -5. Create [GitHub Actions Repository Variables](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables) for the following values +4. Create [GitHub Actions Repository Variables](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables) for the following values - `ROBLOX_PRODUCTION_UNIVERSE_ID`, `ROBLOX_PRODUCTION_PLACE_ID` - `ROBLOX_TEST_UNIVERSE_ID`, `ROBLOX_TEST_PLACE_ID` -6. (Optional) add [GitHub branch protection rules](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule) to validate the checks have been passed on PRs before they have been merged +5. (Optional) add [GitHub branch protection rules](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule) to validate the checks have been passed on PRs before they have been merged ## Notes @@ -38,4 +37,4 @@ A special thanks is given to the creators of Rojo, Selene and StyLua for creatin * The Engine Open Cloud API for Executing Luau is currently limited to one concurrent request per universe. The GitHub actions config in this example accounts for this by creating a [concurrency group](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/control-the-concurrency-of-workflows-and-jobs). This will prevent Luau execution jobs from attempting to run concurrently and failing. * Note, we aim to lift this limit in the future. * An example PR is given showing CI checks failing: [example](https://github.com/Roblox/place-ci-cd-demo/pull/1) -* Because the CI/CD pipeline requires an Open Cloud API key to run, more work is required for use in Open Source projects where fork maintainers will have to create these places, variables and API keys themselves for checks to run correctly on their forks. \ No newline at end of file +* Because the CI/CD pipeline requires an Open Cloud API key to run, more work is required for use in Open Source projects where fork maintainers will have to create these places, variables and API keys themselves for checks to run correctly on their forks.