doc: added docs for dataset update #766
Conversation
| After adding files from a remote Git repository, you can check for updates in | ||
| those files by using ``renku dataset update`` command. This command checks all | ||
| remote files and copies over new content if there are any. It also deletes | ||
| files from the local dataset if they are deleted from the remote Git |
There was a problem hiding this comment.
Hmm I hadn't thought of that before but I guess this will lead to some unexpected behavior. Is there an issue already for updating to a specific commit?
There was a problem hiding this comment.
Not yet. It was supposed to be part of this one but I decided to do it later. I'll create on when we close this one. I don't see though how that would help; if a file is deleted from the latest update eventually we need a way to deal with it.
There was a problem hiding this comment.
Yes sure, but right now I can imagine someone could do an update that deleted a file with no way to get back other than doing a git reset. If they were able to go to a previous commit it would be a non-issue.
There was a problem hiding this comment.
anyway, this is not the right place for this discussion I realize :) We should add support for updating to a specific commit reasonably soon to avoid having users that get stuck in some strange state.
There was a problem hiding this comment.
As we discussed, I'll ask the user to provide an explicit flag for deletion.
| You can limit the scope of updated files by specifying dataset names, using | ||
| ``--include`` and ``--exclude`` to filter based on file names, or using | ||
| ``--creators`` to filter based on creators. For example, the following command |
There was a problem hiding this comment.
creators - as determined by the email?
There was a problem hiding this comment.
No, it is the full name of the creator. This is like some other dataset subcommands (e.g. ls-files)
|
I'll add changes in this PR to #765 and close this one. |
IMPORTANT: Please do not create a Pull Request without creating an issue first.
Description
Document for
renku dataset updateFixes #763
Type of change
Please select relevant options.
Checklist
Do not create pull request unless you checked all points.
(https://github.com/SwissDataScienceCenter/documentation/wiki/files/SDSC_Contributor_License_Agreement_v1.0.pdf).
./run-tests.shlocally.