Skip to content
This repository was archived by the owner on Sep 25, 2024. It is now read-only.

Commit c5f826d

Browse files
Merge pull request #4 from Roblox/othomson-roblox-patch-1
Update README.md
2 parents 679cda3 + ec16bd4 commit c5f826d

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,10 @@ A special thanks is given to the creators of Rojo, Selene and StyLua for creatin
2323
- `universe.places:write`
2424
- `universe.place.luau-execution-session:write`
2525
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`
26-
4. Create G
27-
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
26+
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
2827
- `ROBLOX_PRODUCTION_UNIVERSE_ID`, `ROBLOX_PRODUCTION_PLACE_ID`
2928
- `ROBLOX_TEST_UNIVERSE_ID`, `ROBLOX_TEST_PLACE_ID`
30-
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
29+
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
3130

3231
## Notes
3332

@@ -38,4 +37,4 @@ A special thanks is given to the creators of Rojo, Selene and StyLua for creatin
3837
* 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.
3938
* Note, we aim to lift this limit in the future.
4039
* An example PR is given showing CI checks failing: [example](https://github.com/Roblox/place-ci-cd-demo/pull/1)
41-
* 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.
40+
* 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.

0 commit comments

Comments
 (0)