[Notes] [Git][BuildStream/buildstream][chandan/update-requirements-one-liner] CONTRIBUTING.rst: Add instructions to update requirements files

[Chandan Singh <gitlab mg gitlab com>]

Title: GitLab

Chandan Singh pushed to branch chandan/update-requirements-one-liner at BuildStream / buildstream

Commits:

• a6f9795c
  by Chandan Singh at 2019-01-03T23:12:22Z

  CONTRIBUTING.rst: Add instructions to update requirements files
  
  Split the "The MANIFEST.in and setup.py" section in two:
  "Managing data files" and "Updating BuildStream's Python dependencies".
  
  Briefly explain the layout of `requirements` directory and add
  instructions to use the Makefile added in the last commit.
  

1 changed file:

• CONTRIBUTING.rst

Changes:

CONTRIBUTING.rst

---

...	...	@@ -1736,10 +1736,8 @@ obtain profiles::
1736	1736	ForceCommand BST_PROFILE=artifact-receive cd /tmp && bst-artifact-receive --pull-url https://example.com/ /home/artifacts/artifacts
1737	1737
1738	1738
1739		-The MANIFEST.in and setup.py
1740		-----------------------------
1741		-When adding a dependency to BuildStream, it's important to update the setup.py accordingly.
1742		-
	1739	+Managing data files
	1740	+-------------------
1743	1741	When adding data files which need to be discovered at runtime by BuildStream, update setup.py accordingly.
1744	1742
1745	1743	When adding data files for the purpose of docs or tests, or anything that is not covered by
...	...	@@ -1749,3 +1747,23 @@ At any time, running the following command to create a source distribution shoul
1749	1747	creating a tarball which contains everything we want it to include::
1750	1748
1751	1749	./setup.py sdist
	1750	+
	1751	+
	1752	+Updating BuildStream's Python dependencies
	1753	+------------------------------------------
	1754	+BuildStream's Python dependencies are listed in multiple
	1755	+`requirements files <https://pip.readthedocs.io/en/latest/reference/pip_install/#requirements-file-format>`
	1756	+present in the ``requirements`` directory.
	1757	+
	1758	+All ``.txt`` files in this directory are generated from the corresponding
	1759	+``.in`` file, and each ``.in`` file represents a set of dependencies. For
	1760	+example, ``requirements.in`` contains all runtime dependencies of BuildStream.
	1761	+``requirements.txt`` is generated from it, and contains pinned versions of all
	1762	+runtime dependencies (including transitive dependencies) of BuildStream.
	1763	+
	1764	+When adding a new dependency to BuildStream, or updating existing dependencies,
	1765	+it is important to update the appropriate requirements file accordingly. After
	1766	+changing the ``.in`` file, run the following to update the matching ``.txt``
	1767	+file::
	1768	+
	1769	+ make -C requirements

—
View it on GitLab.
You're receiving this email because of your account on gitlab.com. If you'd like to receive fewer emails, you can adjust your notification settings.