Skip to content

Latest commit

 

History

History
24 lines (13 loc) · 1.37 KB

004_provide_upgrade_instructions-with-new-version-releases.md

File metadata and controls

24 lines (13 loc) · 1.37 KB

4. Provide upgrade instructions with new version releases

Date: 2020-06-30

Context

Tropical is a template repo and not a semver-based library that you can upgrade in the background.

A consequence of this is that after you create a new project from the Tropical template, you're on your own with regards to dependency upgrades or incorporating new features.

Merging changes from the template by configuring it as an upstream repository is possible, but not really useful. I want projects to diverge heavily from the Tropical template repo, which will make this kind of merge pretty painful.

Decision

Publish a release for any changes to the master branch that includes:

  • A description of changes
  • Instructions for upgrading from the previous version

Consequences

Upgrade instructions aren't intended to make your downstream project identical to the template repo or provide instant feature parity, since your project has probably diverged and added, removed or extended features.

I think that's OK. These instructions are simply intended as a guide to help you keep your project pretty close to the current Tropical way of doing things.