Skip to content

Commit 0c8df11

Browse files
committed
Document pipeline prerequisites and configuration
1 parent c31755a commit 0c8df11

File tree

2 files changed

+14
-6
lines changed

2 files changed

+14
-6
lines changed

.github/workflows/main.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ jobs:
8787
git reset --hard
8888
sudo git clean -d -x -f
8989
rm -r *
90-
git add *
90+
git add -A
9191
git commit -m "cleaning branch"
9292
git push
9393
- name: Applying stashed files to ${{ vars.DEPLOYMENT_BRANCH }}

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,13 @@ gitGraph
6666

6767
### Steps
6868

69+
#### Pipeline prerequisites
70+
- **Unity license activation**: Request a personal license and generate the `UNITY_LICENSE` file following the [GameCI activation guide](https://game.ci/docs/github/activation).
71+
- **GitHub secrets**: Create the following repository secrets so the workflow can authenticate with Unity and GitHub:
72+
- `PAT`: Personal access token with `repo` scope to allow pushing to the deployment branch.
73+
- `UNITY_LICENSE`, `UNITY_EMAIL`, `UNITY_PASSWORD`: Credentials required by the Unity Builder action.
74+
- `GH_EMAIL`, `GH_USERNAME`: Identity used when the workflow commits deployment changes.
75+
6976
#### Adding necessary files to the repo
7077
1. Create a .github folder
7178
2. Create a workflows folder inside of the recently created .github folder
@@ -78,11 +85,12 @@ gitGraph
7885
#### Acquire the activation file
7986
Execute the Acquire Activation File job included in the activation.yml file manually from the Actions tab and [GameCI Documentation](https://game.ci/docs/github/activation).
8087

81-
#### Setup repository variables
82-
- TARGET_PLATFORM: Unity project build target platform
83-
- BUILD_PATH: Were the build will be created. This folder should not be included in the .gitignore file.
84-
- ARTIFACT_NAME: The output zip file name.
85-
- DEPLOYMENT_BRANCH: The source branch for Github Pages.
88+
#### Configure pipeline variables
89+
Define the following repository variables from **Settings → Secrets and variables → Actions → Variables** so the workflow can locate build outputs and target branch information:
90+
- `TARGET_PLATFORM`: Unity project build target platform.
91+
- `BUILD_PATH`: Directory where the build will be created. This folder should not be ignored by git.
92+
- `ARTIFACT_NAME`: The output zip file name.
93+
- `DEPLOYMENT_BRANCH`: The source branch for Github Pages deployments.
8694

8795

8896

0 commit comments

Comments
 (0)