Release v3.0 Binaries - Githubissues

AdamsLair / duality

a 2D Game Development Framework

https://adamslair.github.io/duality

MIT License

1.41k stars 288 forks source link

Release v3.0 Binaries #642

Closed ilexp closed 5 years ago

ilexp commented 6 years ago

Summary

As we're slowly approaching the v3.0 milestone, investigate what final steps need to be taken in order to release. Do not approach this issue as long as any other issues are open in this milestone.

Analysis

Pre-Release testing
- Call to the community to check out the v3.0 release candidate and work with it for a while. Gather feedback and fix bugs.
Merge all source code
- Branch 2.x off master.
- Merge develop-3.0 into master.
Release binaries
- Tick all major version numbers using the build script.
- Merge master into release.
- Build and manually deploy new sandcastle help files for v3.0.
Update docs
- Change home page version and page links to v3, so it will become the new default docs version.
Post-Release testing
- Download Duality and do a fresh install.
- Test all sample projects.
- Write a bit of code and get it up and running.

ilexp commented 6 years ago

Progress

Renamed 1.x branch to archive/1.x.
Renamed feature/3.0/netstandard branch to feature/netstandard.
Branched off archive/2.x from master.
Merged develop-3.0 into master and deleted the merged branch.
Updated the readme home page to link to v3 docs and include the new AppVeyor icons.

ToDo

Test-upgrade a v2 DualStickSpaceShooter sample project to v3
- Fix all occurrences of failed error handling causing an inconsistent editor state.
- Improve serialization error handling to avoid very high load times when lots of errors occur.
Write a quick upgrade guideline in the docs repo.
- Which projects should consider upgrading?
- How to upgrade, a rough guideline.
Prepare a v3.0 release statement on the blog.
- Link to the upgrade guideline
Release binaries
- Tick all major version numbers using the build script.
- Merge master into release.
- Build and manually deploy new sandcastle help files for v3.0.
Update docs
- Change home page version and page links to v3, so it will become the new default docs version.
- Post v3.0 release statement on the blog.
Post-Release testing
- Download Duality and do a fresh install.
- Test all sample projects.
- Write a bit of code and get it up and running.

ilexp commented 5 years ago

Progress

Improved Serializer handling of severely outdated data by reducing per-object / per-item log spam and aggregating messages where easily possible.

ToDo

Test-upgrade a v2 DualStickSpaceShooter sample project to v3
- Fix all occurrences of failed error handling causing an inconsistent editor state.
Write a quick upgrade guideline in the docs repo.
- Which projects should consider upgrading?
- How to upgrade, a rough guideline.
Prepare a v3.0 release statement on the blog.
- Link to the upgrade guideline
Release binaries
- Tick all major version numbers using the build script.
- Merge master into release.
- Build and manually deploy new sandcastle help files for v3.0.
Update docs
- Change home page version and page links to v3, so it will become the new default docs version.
- Post v3.0 release statement on the blog.
Post-Release testing
- Download Duality and do a fresh install.
- Test all sample projects.
- Write a bit of code and get it up and running.

ilexp commented 5 years ago

Progress

Improved handling of failed to load internal data for Font, Material and Pixmap resources to avoid exceptions at runtime.

ToDo

Test-upgrade a v2 DualStickSpaceShooter sample project to v3
- Fix all occurrences of failed error handling causing an inconsistent editor state.
Write a quick upgrade guideline in the docs repo.
- Which projects should consider upgrading?
- How to upgrade, a rough guideline.
Prepare a v3.0 release statement on the blog.
- Link to the upgrade guideline
Release binaries
- Tick all major version numbers using the build script.
- Merge master into release.
- Build and manually deploy new sandcastle help files for v3.0.
Update docs
- Change home page version and page links to v3, so it will become the new default docs version.
- Post v3.0 release statement on the blog.
Post-Release testing
- Download Duality and do a fresh install.
- Test all sample projects.
- Write a bit of code and get it up and running.

ilexp commented 5 years ago

Progress

Extended compatibility plugin to automatically handle the most common renamed type scenarios from v2 to v3.
Wrote a brief upgrade guideline in the docs, describing the required steps to upgrade a v2 project to v3, as well as some points on whether or not to upgrade in the first place.
Various version updater tool bugfixes to address issues in resolving project output paths. Also added a special mode for applying a big global version update.
Updated version numbers in nuspecs and assembly infos to prepare for release.
Fixed NightlyBuilder not reporting why a pack operation failed.
Fixed missing Copy step in PackageManagerFrontend project causing the plugins pack operation to fail.

ToDo

Pre-Release testing
- Do a full build with all packages.
- Test a new install using a local package repository.
- Also test an v2 to v3 update locally.
Prepare a v3.0 release statement on the blog.
- Link to the upgrade guideline
Release binaries
- Merge master into release.
- Build and manually deploy new sandcastle help files for v3.0.
Update docs
- Change home page version and page links to v3, so it will become the new default docs version.
- Post v3.0 release statement on the blog.
Post-Release testing
- Download Duality and do a fresh install.
- Test all sample projects.
- Write a bit of code and get it up and running.

ilexp commented 5 years ago

Progress

Rebuilt all packages with their new v3 compatible versions and set up a local repository for testing fresh installs and updates.
Tested a fresh install of Duality v3 locally using the new binary download zip. Installation works as expected.
Found a Benchmarks Sample bug where having it installed makes all other samples and scenes useless due to globally installing its custom RenderSetup instance.

ToDo

Fix the Benchmarks Sample bug leaking its custom RenderSetup and breaking all other samples while installed itself.
Pre-Release testing
- Test an v2 to v3 update locally.
Prepare a v3.0 release statement on the blog.
- Link to the upgrade guideline
Release binaries
- Merge master into release.
- Build and manually deploy new sandcastle help files for v3.0.
Update docs
- Change home page version and page links to v3, so it will become the new default docs version.
- Post v3.0 release statement on the blog.
Post-Release testing
- Download Duality and do a fresh install.
- Test all sample projects.
- Write a bit of code and get it up and running.

ilexp commented 5 years ago

Progress

Fixed the aforementioned Benchmarks Sample bug.

ToDo

Pre-Release testing
- Test an v2 to v3 update locally.
Prepare a v3.0 release statement on the blog.
- Link to the upgrade guideline
Release binaries
- Merge master into release.
- Build and manually deploy new sandcastle help files for v3.0.
Update docs
- Change home page version and page links to v3, so it will become the new default docs version.
- Post v3.0 release statement on the blog.
Post-Release testing
- Download Duality and do a fresh install.
- Test all sample projects.
- Write a bit of code and get it up and running.

ilexp commented 5 years ago

Progress

Tested a fresh v3 install and a v2 to v3 update using a local repository and found no issues.
Merged master into release and deployed v3 binaries.
Switched docs default to v3.

ToDo

Publish v3.0 release statements.

ilexp commented 5 years ago

Wrote a small release statement on the blog and announced the official v3 release via Twitter and community chat. Closing this.