Skip to content

Commit 002ba64

Browse files
committed
docs: Apply some recommendations to docs
1 parent 27ecd3d commit 002ba64

File tree

2 files changed

+45
-6
lines changed

2 files changed

+45
-6
lines changed

docs/05-gitlab/01-getting-started.mdx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,12 @@ git checkout v4.0.0
7171
cd ..
7272
```
7373

74-
:::info See
75-
[example project's release](https://gitlab.com/game-ci/unity3d-gitlab-ci-example/-/releases) for
76-
stable versions. :::
74+
:::info
75+
76+
See [example project's release](https://gitlab.com/game-ci/unity3d-gitlab-ci-example/-/releases) for
77+
stable versions.
78+
79+
:::
7780

7881
#### 3. Navigate to Your Unity Project
7982

docs/05-gitlab/02-activation.mdx

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@ Check out the [Troubleshooting / Common Issues][common-issues] section.
88

99
:::
1010

11+
:::info
12+
13+
Refer to
14+
[Unity's official licensing documentation](https://docs.unity3d.com/Manual/LicensesAndActivation.html)
15+
for more details about Unity activation.
16+
17+
:::
18+
1119
To run Unity in a CI/CD pipeline, you need to activate your license. For details about how the
1220
activation process works, refer to the following scripts:
1321

@@ -103,6 +111,12 @@ If you have trouble locating the `.ulf` file, follow these steps:
103111
Get-Content Unity_lic.ulf | Select-String -Pattern 'DeveloperData' | ForEach-Object { $_ -replace '.*Value="([^"]+)".*', '$1' } | [System.Convert]::FromBase64String($_)
104112
```
105113

114+
:::info Expected Serial Format
115+
116+
The serial should look like this: `XX-XXXX-XXXX-XXXX-XXXX-XXXX`.
117+
118+
:::
119+
106120
### 3. Storing the Serial in GitLab CI/CD
107121

108122
**Add the extracted serial** to your GitLab project’s CI/CD Variables:
@@ -111,13 +125,20 @@ If you have trouble locating the `.ulf` file, follow these steps:
111125
- `UNITY_EMAIL`: The email address associated with your Unity account
112126
- `UNITY_PASSWORD`: The password for your Unity account
113127

114-
:::caution Variables are not set in your pipelines?
128+
:::info Variables are not set in your pipelines?
115129

116130
Make sure you unchecked the "protected" checkbox for these variables if you want them to be
117131
available for all branches and merge requests.
118132

119133
:::
120134

135+
:::caution Security Warning
136+
137+
Keep your extracted serial and credentials secure. Never commit them to version control or share
138+
them publicly.
139+
140+
:::
141+
121142
You're all set! The pipeline will use these credentials to activate Unity automatically. 🎉
122143

123144
---
@@ -133,13 +154,20 @@ If you have **Unity Plus** or **Unity Pro**, you have an **official serial key**
133154
- `UNITY_EMAIL`
134155
- `UNITY_PASSWORD`
135156

136-
:::caution Using "protected" variables will make them available only to protected branches
157+
:::info Using "protected" variables will make them available only to protected branches
137158

138159
Make sure you unchecked the "protected" checkbox for these variables if you want them to be
139160
available for all branches and merge requests.
140161

141162
:::
142163

164+
:::caution Security Warning
165+
166+
Keep your extracted serial and credentials secure. Never commit them to version control or share
167+
them publicly.
168+
169+
:::
170+
143171
You're all set! The pipeline will use these credentials to activate Unity automatically. 🎉
144172

145173
---
@@ -156,7 +184,7 @@ variables:
156184
UNITY_LICENSING_SERVER: 'ssl://your-license-server.company.com:443'
157185
```
158186
159-
:::caution Using "protected" variables will make them available only to protected branches
187+
:::info Using "protected" variables will make them available only to protected branches
160188
161189
Make sure you unchecked the "protected" checkbox for these variables if you want them to be
162190
available for all branches and merge requests.
@@ -201,6 +229,14 @@ If it finishes without errors, a `.ulf` should be located in
201229
`/root/.local/share/unity3d/Unity/Unity_lic.ulf`. You can use or reference that file in your GitLab
202230
environment.
203231

232+
:::caution Security Warning
233+
234+
Executing shell commands directly in your terminal can expose your credentials in your shell
235+
history. To avoid this, consider writing the commands to a shell script and executing the script
236+
instead.
237+
238+
:::
239+
204240
## Next Steps
205241

206242
Once your license is activated in GitLab CI, you can:

0 commit comments

Comments
 (0)