Skip to content

Commit 8eef92a

Browse files
authored
Merge pull request #170 from brunomikoski/feature/info-files-update-for-2.4.0
fix: info files for 2.4.0
2 parents f6a6c70 + 6b7bc13 commit 8eef92a

File tree

3 files changed

+68
-3
lines changed

3 files changed

+68
-3
lines changed

CHANGELOG.MD

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,15 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7-
## [Unreleased]
8-
## [2.3.9] - 19/02/2025
7+
## [2.4.0] - 24/05/2025
98
## Changed
109
- Fixed generated static access code overwriting the collection definition
1110
- Pre 2.3.0 collections will now be assumed to want a namespace setting that is the same namespace as its item type
1211
- When generating static/indirect access code using the new `.g.cs` suffix, existing static/indirect access code that uses the old `.cs` suffix is now automatically removed to prevent compile errors
12+
- Added Generic SetValue for Collection Generator
13+
1314

15+
## [2.3.9] - 19/02/2025
1416
## Changed
1517
- Added some general fixes to validate Collection and Items have unique `LongGuid`
1618
- Fixed issues when after some operation with the context menu on the CollectionEditor items would not refresh properly

README.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,3 +141,66 @@ You can also add it directly from GitHub on Unity 2019.4+. Note that you won't b
141141
- paste `https://github.com/brunomikoski/ScriptableObjectCollection.git`
142142
- click <kbd>Add</kbd>
143143
</details>
144+
145+
146+
## Upgrading Guide: < 2.3.0 ➡️ 2.4.0
147+
148+
<details>
149+
<summary><strong>⚠️ Upgrading from &lt;2.3.0 to 2.4.0 — Important Migration Notes</strong></summary>
150+
151+
152+
If you are upgrading **ScriptableObjectCollection** from a version prior to **2.3.0** to **2.4.0**, please read this section carefully to avoid breaking changes and compile errors.
153+
154+
---
155+
156+
### 1. Generated Files Now Use the `.g.cs` Suffix
157+
158+
- All generated static files now use the `.g.cs` suffix.
159+
- **Action Required:**
160+
Manually **delete any previously generated files that do NOT have the `.g.cs` suffix** from your project.
161+
Keeping these files may cause compile errors after the upgrade.
162+
163+
---
164+
165+
### 2. Namespace and Filename Settings Have Moved
166+
167+
- Namespace and filename settings are now stored in the `.meta` file instead of in the generator/collection files.
168+
- Any custom settings will need to be **reconfigured** after the upgrade.
169+
- Old settings are not automatically migrated.
170+
171+
---
172+
173+
### 3. Breaking Changes & Versioning
174+
175+
- This release introduces breaking changes that may cause compile errors if migration steps are not followed.
176+
- Make sure to **read and follow these instructions** before or after upgrading.
177+
178+
---
179+
180+
### 4. Automatic Cleanup
181+
182+
- Starting from **2.4.0**, the package attempts to **automatically delete obsolete generated `.cs` files** (without the `.g.cs` suffix) during the upgrade process.
183+
- However, always **double-check** your generated files and remove any leftovers if necessary.
184+
185+
---
186+
187+
### 5. Troubleshooting
188+
189+
If you encounter problems after upgrading:
190+
- Ensure **all old generated files** without `.g.cs` are deleted.
191+
- Check your collection settings, as these may need to be **set again** due to the migration to `.meta` files.
192+
- Confirm you are using the latest version (**2.4.0** or newer).
193+
- If issues persist, please [open an issue](https://github.com/brunomikoski/ScriptableObjectCollection/issues).
194+
195+
---
196+
197+
### **Migration Steps Checklist**
198+
199+
1. **Delete all previously generated files that do not end with `.g.cs`.**
200+
2. **Update the package to version 2.4.0.**
201+
3. **Reconfigure your namespace/filename settings if needed.**
202+
4. **Verify your project compiles and all generators work as expected.**
203+
204+
---
205+
206+
</details>

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "com.brunomikoski.scriptableobjectcollection",
33
"displayName": "Scriptable Object Collection",
4-
"version": "2.3.9",
4+
"version": "2.4.0",
55
"unity": "2022.2",
66
"description": "A library to help improve the usability of Unity3D Scriptable Objects by grouping them into a collection and exposing them by code or nice inspectors!",
77
"keywords": [

0 commit comments

Comments
 (0)