-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Viktor Dick
committed
Nov 2, 2023
1 parent
36b0a58
commit 0462bf0
Showing
2 changed files
with
18 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,5 @@ | ||
unreleased | ||
* Update README | ||
* Explicitly name git branch in tests | ||
|
||
22.2.5 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,19 +19,25 @@ Viktor Dick <[email protected]> | |
|
||
The package should be installed using `pip` in the same virt-env as `zope`, p.e. | ||
|
||
zope/bin/pip install git+https://github.com/perfact/zodbsync | ||
zope/bin/pip install perfact-zodbsync | ||
|
||
On PerFact systems, it should automatically be pulled by the `requirements.txt` | ||
of the package `perfact-dbutils-zope4` and included there. If installing on an | ||
older system, run | ||
|
||
sudo -H /opt/zope/zope2.13/bin/pip install git+https://github.com/perfact/zodbsync | ||
of the package `perfact-dbutils-zope4` and included there. | ||
|
||
On newer PerFact Zope4 installations, install `test` branch via, e.g. for | ||
development/testing purposes | ||
|
||
sudo -H /usr/share/perfact/zope4/bin/pip install git+https://github.com/perfact/zodbsync@test --upgrade | ||
|
||
If the `setuptools` version used by the Zope virtualenv is too old (for | ||
example, on Ubuntu 20.04 or 22.04), you need to build the package in a separate | ||
virtualenv using a new `setuptools` version and then install it: | ||
|
||
virtualenv build-venv | ||
build-venv/bin/pip install 'setuptools>=61.2' build | ||
build-venv/bin/python -m build | ||
sudo -H /usr/share/perfact/zope4/bin/pip install dist/$(ls -t dist/*.tar.gz | head -n 1) | ||
|
||
Note that executing the tests requires ODBC C headers to be installed. On | ||
Debian-like systems, install the package `unixodbc-dev`. | ||
|
||
|
@@ -188,7 +194,8 @@ aware that there is no check that the commit range is actually a straight | |
forward succession - internally, `git log` is used and therefore any commits | ||
that are reachable from `COMMIT2` but not from `COMMIT1` are picked. In | ||
practice, choosing commits that are not directly connected will result in some | ||
commit not being able to be picked due to conflicts. | ||
commit not being able to be picked due to conflicts and a rollback of the | ||
operation. | ||
|
||
|
||
### `zodbsync upload` (DEPRECATED) | ||
|
@@ -202,6 +209,10 @@ Example to upload bootstrap: | |
|
||
zodbsync upload /tmp/bootstrap lib/bootstrap | ||
|
||
This subcommand is deprecated because external libraries should not be put into | ||
the Data.FS. Instead, it is more efficient if they are served directly from the | ||
file system. | ||
|
||
### `zodbsync with-lock` | ||
|
||
If some combination of `git` and `zodbsync` operations is not yet covered by a | ||
|
@@ -283,8 +294,3 @@ holds for `Z SQL Method`s which have `class_name` and `class_file` set to a no | |
longer existing extension. | ||
|
||
## To Do / Roadmap | ||
|
||
* Specifying a path to a python script that is executed after `playback` | ||
inside the same transaction will allow to store database changes in a | ||
connected relational (SQL) database inside ZODB using Z SQL Methods and | ||
have them executed as part of the same deployment step. |