Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MRG] update the migration guide for 4.0 with version pinning instructions #1330

Merged
merged 2 commits into from
Feb 15, 2021

Conversation

ctb
Copy link
Contributor

@ctb ctb commented Feb 15, 2021

Per #1016 (comment)

Note, this is a PR into #1283

Checklist

  • Is it mergeable?
  • make test Did it pass the tests?
  • make coverage Is the new code covered?
  • Did it change the command-line interface? Only additions are allowed
    without a major version increment. Changing file formats also requires a
    major version number increment.
  • Was a spellchecker run on the source code and documentation after
    changes were made?

@luizirber
Copy link
Member

luizirber commented Feb 15, 2021

I just saw this "upgrade process" in https://www.oxinabox.net/2021/02/13/Julia-1.6-what-has-changed-since-1.0.html#deprecations-are-muted-by-default and it might be useful to have something similar in the upgrade notes:

Solving deprecations is a thing you should actively choose to do rather than casually when trying to do something else. In particular, when updating to support a new major release of one of your dependencies, you should follow a process. Something like:

  • Check the release notes.
  • Relax compat bounds
  • Run your integration tests, if everything passes you are done.
  • If tests failed, revert the change to compat bounds, then rerun your integration tests paying attention to deprecation warnings.

Updating your dependencies should be an active choice. Potentially one that is automated, but not one that you do while adding another feature (if you can help it).

@ctb ctb requested a review from luizirber February 15, 2021 21:28
@ctb
Copy link
Contributor Author

ctb commented Feb 15, 2021

done! I restructured things a bit and removed some redundancy, too.

@luizirber luizirber merged commit c802035 into docs_4.0 Feb 15, 2021
@luizirber luizirber deleted the update/migration_guide_40 branch February 15, 2021 22:51
ctb added a commit that referenced this pull request Feb 17, 2021
* start adjusting docs

* add migration links

* switch compute over to sketch in most of the markdown docs

* fix --scaled and --track-abundance thruought

* formatting and wording fixes

* add sourmash sketch docs

* substantial update for API examples

* add ToC to api-example

* fix heading for API section

* bold API examples link

* (untested) update of tutorials to use sourmash sketch

* update link targets

* updates of indexed databases

* typos in versioning (#1314)

* Apply suggestions from code review

Co-authored-by: Taylor Reiter <taylorreiter@gmail.com>

* Update doc/api-example.md

Co-authored-by: Taylor Reiter <taylorreiter@gmail.com>

* updated with suggestions from @taylorreiter doc review

* added section on sketch naming

* [WIP] add migration docs and release notes (#1316)

* add migration docs and release notes

* Update doc/support.md

Co-authored-by: Taylor Reiter <taylorreiter@gmail.com>

* Update doc/support.md

Co-authored-by: Taylor Reiter <taylorreiter@gmail.com>

* Update doc/release-notes/sourmash-4.0.md

Co-authored-by: Taylor Reiter <taylorreiter@gmail.com>

* Update doc/release-notes/sourmash-4.0.md

Co-authored-by: Taylor Reiter <taylorreiter@gmail.com>

* Update doc/release-notes/sourmash-4.0.md

Co-authored-by: Taylor Reiter <taylorreiter@gmail.com>

* update with last set of changes

* add missing line break

Co-authored-by: Taylor Reiter <taylorreiter@gmail.com>

* resolve missing link

* update tutorials and notebooks for 4.0

* [MRG] update the migration guide for 4.0 with version pinning instructions (#1330)

* update 4.0 migration docs with version pinning instructions

* update migration docs

* Apply suggestions from code review

Co-authored-by: Luiz Irber <luizirber@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Luiz Irber <luizirber@users.noreply.github.com>

Co-authored-by: Taylor Reiter <taylorreiter@gmail.com>
Co-authored-by: Luiz Irber <luizirber@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants