status-im
/
nim-workplace
mirror of https://github.com/status-im/nim-workplace.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Some clarifications regarding syncing the lock file and the vendor folder

This commit is contained in:
zah 2022-09-14 17:41:02 +03:00 committed by GitHub
parent 7a3d4d07c1
commit abb4952a4d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -36,10 +36,11 @@ will try to add all vendored submodules as folders in the workspace.
This script must be executed within a repository using a `vendor` folder. It This script must be executed within a repository using a `vendor` folder. It
will copy the current revisions of submodules in the vendor folder to the will copy the current revisions of submodules in the vendor folder to the
matching folder in the workspace if present. Typically, the scrupt is executed matching folder in the workspace if present. Typically, the script is executed
after pulling git revisions that bump vendor sumbodules without also bumping after pulling git revisions from other team members that have bumped vendor
the same packages in the Nimble lock file. To resolve the discrepancy, the sumbodules without also bumping the same packages in the Nimble lock file.
developer would execute the following commands: To resolve the arising discrepancy, the developer would execute the following
commands:
```bash ```bash
# Pull the project files as usual # Pull the project files as usual
@ -61,4 +62,5 @@ This script must be executed within a repository using a `vendor` folder. It
will copy the revisions from the current workspace folders to the matching will copy the revisions from the current workspace folders to the matching
submodules in the vendor folder. When you use a workspace and make changes submodules in the vendor folder. When you use a workspace and make changes
to the lockfile (by changing any of the dependencies) you must execute this to the lockfile (by changing any of the dependencies) you must execute this
script before commiting to reflect the same change in the vendor folder. script before commiting to reflect the same change in the vendor folder, so
the project can continue building properly without Nimble.