[Bug Report] Insufficient release notes
aditya-cherukuri opened this issue · 2 comments
Description
I see there were a couple of version bumps including a major version bump that moved privacy enforcement to a new package. Packwerk validate fails after the version 3.0.0 upgrade
To Reproduce
- Upgrade the packwerk dependency to version 3.0.0.
- Run packwerk validate
Expected Behaviour
Clear definition on how to resolve breaking changes. It would be nice if an upgrade guide was published with steps conveying how to safely upgrade from 2.x to 3.0.
Version Information
- Packwerk: 2.3.0 -> 3.0.0
- Ruby 3.1.1
Additional Context
How have you tried to solve the issue?
The deprecated-references.yml file wasn't automatically renamed in the packages were we use this. Even after I ran Dir['**/deprecated_references.yml'].each{|f| File.rename(f, f.gsub('deprecated_references', 'package_todo')) } I had to remove the "enabled_privacy" and "public_path" keys from all of the package_todo.yml files. Only after doing all of them did the validate and check commands start passing.
It would be nice if an upgrade guide was published with steps conveying how to safely upgrade from 2.x to 3.0.
We do have this. Please see the upgrade guide.
The deprecated-references.yml file wasn't automatically renamed in the packages were we use this.
This should've happened when you upgraded to 2.3.0 and ran bin/packwerk update on your application. The renaming code actually still exists in 3.0 as well. If this isn't working for you, please open an issue with reproduction steps and I'd be happy to take a look!
Appreciate this! I think it would be helpful to point out that packwerk validate will fail without the removal of the "enabled_privacy" and "public_path" keys from the update-todo.yml files for users that do not go with installing the new privacy gem.
I'll close this issue for now.