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

docs: modules dependency management #3997

Open
slint opened this issue Mar 4, 2020 · 1 comment
Open

docs: modules dependency management #3997

slint opened this issue Mar 4, 2020 · 1 comment

Comments

@slint
Copy link
Member

slint commented Mar 4, 2020

To deal with the dependency management of packages that are commonly used across all the Invenio modules, we're moving to a "centralized" approach of managing them in the following fashion:

  • invenio-base: flask (and werkzeug), six
  • invenio-celery: celery and kombu,
  • invenio-i18n: flask-babelex
  • invenio-admin: flask-admin
  • invenio-accounts: flask-login, flask-security, flask-kvsession

So if e.g. invenio-records depends in its install_requires currently on Flask, we should instead change that to a dependency to invenio-base.

There should be a section in the documentation, describing:

  • How exactly we manage these?
  • What is the process of addressing e.g. issues in any of the upstream libraries (e.g. Flask breaking changes)?
  • How do we approach the minimum/pinned versions of the 3rd-party dependencies (i.e. flask, celery, etc.), and for these "centralized" modules (invenio-base, etc.)
  • In extreme scenarios (e.g. when we need a hotfix), what is the way to tackle these?

Note that this is not an entirely new thing, since we've already been doing this for a while with invenio-db and invenio-search for managing SQLAlchemy and Elasticsearch dependencies.

@slint slint changed the title docs docs: modules dependency management Mar 4, 2020
@slint slint added this to Todo in Sprint Week 10-11 (2020) - V3.3 Release via automation Mar 4, 2020
@lnielsen lnielsen added this to Backlog in Sprint Week 19-20 - Invenio v3.3 via automation May 3, 2020
@lnielsen lnielsen moved this from Backlog to Todo: v3.3 release in Sprint Week 19-20 - Invenio v3.3 May 3, 2020
@lnielsen lnielsen moved this from Todo: v3.3 release to Todo: v3.3 Final in Sprint Week 19-20 - Invenio v3.3 May 3, 2020
@ppanero
Copy link
Member

ppanero commented Aug 4, 2022

@slint @lnielsen is this still relevant or was implemented?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

No branches or pull requests

2 participants