@@ -8,6 +8,14 @@ Check out the [Troubleshooting / Common Issues][common-issues] section.
8
8
9
9
:::
10
10
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
+
11
19
To run Unity in a CI/CD pipeline, you need to activate your license. For details about how the
12
20
activation process works, refer to the following scripts:
13
21
@@ -103,6 +111,12 @@ If you have trouble locating the `.ulf` file, follow these steps:
103
111
Get-Content Unity_lic.ulf | Select-String -Pattern 'DeveloperData' | ForEach-Object { $_ -replace '.*Value="([^"]+)".*', '$1' } | [System.Convert]::FromBase64String($_)
104
112
```
105
113
114
+ :::info Expected Serial Format
115
+
116
+ The serial should look like this: ` XX-XXXX-XXXX-XXXX-XXXX-XXXX ` .
117
+
118
+ :::
119
+
106
120
### 3. Storing the Serial in GitLab CI/CD
107
121
108
122
** 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:
111
125
- ` UNITY_EMAIL ` : The email address associated with your Unity account
112
126
- ` UNITY_PASSWORD ` : The password for your Unity account
113
127
114
- :::caution Variables are not set in your pipelines?
128
+ :::info Variables are not set in your pipelines?
115
129
116
130
Make sure you unchecked the "protected" checkbox for these variables if you want them to be
117
131
available for all branches and merge requests.
118
132
119
133
:::
120
134
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
+
121
142
You're all set! The pipeline will use these credentials to activate Unity automatically. 🎉
122
143
123
144
---
@@ -133,13 +154,20 @@ If you have **Unity Plus** or **Unity Pro**, you have an **official serial key**
133
154
- ` UNITY_EMAIL `
134
155
- ` UNITY_PASSWORD `
135
156
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
137
158
138
159
Make sure you unchecked the "protected" checkbox for these variables if you want them to be
139
160
available for all branches and merge requests.
140
161
141
162
:::
142
163
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
+
143
171
You're all set! The pipeline will use these credentials to activate Unity automatically. 🎉
144
172
145
173
---
@@ -156,7 +184,7 @@ variables:
156
184
UNITY_LICENSING_SERVER : ' ssl://your-license-server.company.com:443'
157
185
` ` `
158
186
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
160
188
161
189
Make sure you unchecked the "protected" checkbox for these variables if you want them to be
162
190
available for all branches and merge requests.
@@ -201,6 +229,14 @@ If it finishes without errors, a `.ulf` should be located in
201
229
` /root/.local/share/unity3d/Unity/Unity_lic.ulf` . You can use or reference that file in your GitLab
202
230
environment.
203
231
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
+
204
240
# # Next Steps
205
241
206
242
Once your license is activated in GitLab CI, you can :
0 commit comments