@@ -30,35 +30,35 @@ The manual process documented in ``CONTRIBUTING.md`` looks like this:
3030How It Improves on the Manual Workflow
3131---------------------------------------
3232
33- +--------------------------------+-----------------------------------------------+------------------------------------------+
34- | Task | Manual | With ``dbx spec `` |
35- +================================+===============================================+==========================================+
36- | Locate the specs repo | Remember/export ``MDB_SPECS `` path | Auto-detected from config |
37- +--------------------------------+-----------------------------------------------+------------------------------------------+
38- | Navigate to the script | ``cd ~/mongo-python-driver/.evergreen `` | Not required |
39- +--------------------------------+-----------------------------------------------+------------------------------------------+
40- | Sync all specs | ``./resync-specs.sh `` | ``dbx spec sync `` |
41- +--------------------------------+-----------------------------------------------+------------------------------------------+
42- | Sync specific specs | ``./resync-specs.sh crud sessions `` | ``dbx spec sync crud sessions `` |
43- +--------------------------------+-----------------------------------------------+------------------------------------------+
44- | Block files by pattern | ``./resync-specs.sh -b "unified" crud `` | ``dbx spec sync crud -b "unified" `` |
45- +--------------------------------+-----------------------------------------------+------------------------------------------+
46- | Sync and apply patches | Run script, then ``git apply -R ... `` | ``dbx spec sync --apply-patches `` |
47- +--------------------------------+-----------------------------------------------+------------------------------------------+
48- | Target a different driver repo | Repeat the ``cd ``/``export `` dance | ``dbx spec sync -r django-mongodb-backend `` |
49- +--------------------------------+-----------------------------------------------+------------------------------------------+
50- | Preview without running | No built-in option | ``dbx spec sync --dry-run `` |
51- +--------------------------------+-----------------------------------------------+------------------------------------------+
52- | Discover available specs | Browse the ``specifications `` repo on disk | ``dbx spec list `` |
53- +--------------------------------+-----------------------------------------------+------------------------------------------+
54- | See active patches | ``ls .evergreen/spec-patch/ `` | ``dbx spec patch list `` |
55- +--------------------------------+-----------------------------------------------+------------------------------------------+
56- | Create a patch file | Manually write/save a git diff | ``dbx spec patch create PYTHON-XXXX `` |
57- +--------------------------------+-----------------------------------------------+------------------------------------------+
58- | Remove a resolved patch | ``rm .evergreen/spec-patch/PYTHON-XXXX.patch``| ``dbx spec patch remove PYTHON-XXXX `` |
59- +--------------------------------+-----------------------------------------------+------------------------------------------+
60- | Apply all patches | ``git apply -R --allow-empty ... `` | ``dbx spec patch apply `` |
61- +--------------------------------+-----------------------------------------------+------------------------------------------+
33+ +--------------------------------+-----------------------------------------------+---------------------------------------------- +
34+ | Task | Manual | With ``dbx spec `` |
35+ +================================+===============================================+============================================== +
36+ | Locate the specs repo | Remember/export ``MDB_SPECS `` path | Auto-detected from config |
37+ +--------------------------------+-----------------------------------------------+---------------------------------------------- +
38+ | Navigate to the script | ``cd ~/mongo-python-driver/.evergreen `` | Not required |
39+ +--------------------------------+-----------------------------------------------+---------------------------------------------- +
40+ | Sync all specs | ``./resync-specs.sh `` | ``dbx spec sync `` |
41+ +--------------------------------+-----------------------------------------------+---------------------------------------------- +
42+ | Sync specific specs | ``./resync-specs.sh crud sessions `` | ``dbx spec sync crud sessions `` |
43+ +--------------------------------+-----------------------------------------------+---------------------------------------------- +
44+ | Block files by pattern | ``./resync-specs.sh -b "unified" crud `` | ``dbx spec sync crud -b "unified" `` |
45+ +--------------------------------+-----------------------------------------------+---------------------------------------------- +
46+ | Sync and apply patches | Run script, then ``git apply -R ... `` | ``dbx spec sync --apply-patches `` |
47+ +--------------------------------+-----------------------------------------------+---------------------------------------------- +
48+ | Target a different driver repo | Repeat the ``cd ``/``export `` dance | ``dbx spec sync -r django-mongodb-backend `` |
49+ +--------------------------------+-----------------------------------------------+---------------------------------------------- +
50+ | Preview without running | No built-in option | ``dbx spec sync --dry-run `` |
51+ +--------------------------------+-----------------------------------------------+---------------------------------------------- +
52+ | Discover available specs | Browse the ``specifications `` repo on disk | ``dbx spec list `` |
53+ +--------------------------------+-----------------------------------------------+---------------------------------------------- +
54+ | See active patches | ``ls .evergreen/spec-patch/ `` | ``dbx spec patch list `` |
55+ +--------------------------------+-----------------------------------------------+---------------------------------------------- +
56+ | Create a patch file | Manually write/save a git diff | ``dbx spec patch create PYTHON-XXXX `` |
57+ +--------------------------------+-----------------------------------------------+---------------------------------------------- +
58+ | Remove a resolved patch | ``rm .evergreen/spec-patch/PYTHON-XXXX.patch``| ``dbx spec patch remove PYTHON-XXXX `` |
59+ +--------------------------------+-----------------------------------------------+---------------------------------------------- +
60+ | Apply all patches | ``git apply -R --allow-empty ... `` | ``dbx spec patch apply `` |
61+ +--------------------------------+-----------------------------------------------+---------------------------------------------- +
6262
6363Prerequisites
6464-------------
0 commit comments