Revert or go back in time and return to your previous version of your work in WVS
Iterating on code and assets is a fundamental part of the game development process. It’s common to be working on code or assets and then need to return to a previous version of your work, either because of a bug, some feedback, or simply wanting to try a different variation. Being able to go back in history and easily manage changes across the team is vital. Here are some best practices to return to previous versions of your work.
Different situations require a unique resolution. Here are some scenarios to consider:
Manage local changes that have not been committed
If you started making edits on your project but haven’t gone any farther than just saving it locally, we provide some steps to help you undo those changes. The process will vary based on the tool you use.
For WVS Desktop Client users, we will walk you through the process here.
For Unreal Engine Plugin usrs, you can find the information here.
WVS Command Line tool users can find instruction here.
If you’re using the the Git passthrough, you can find that documented here.
Manage local changes committed locally but not pushed to remote
With the Git passthrough, when you are done working on a project and are ready to commit your changes, first, you commit your change locally. A local commit is similar to saving your progress in Git. This step is still only occurring in your local machine. At this point, you decide you want to undo a change that you made to the file/files that was already committed. More information on how to undo these changes using the Git passthrough can be found here.
Manage changes that has been pushed to the cloud
Another scenario using the Git passthrough is when you complete your work, save your changes locally by committing them, and decide you’re ready to push them to your remote repository. Occasionally, you’ll want to undo that change but realize it’s already been pushed but you’re unsure what the process is. Read through the Documentation on undoing that change with the Git passthrough here.
Terms to understand
Commits: Commit is a common term in WVS or Git. You can compare a commit to when you save a file, except a commit creates a unique ID that helps you organize each change to the file. With a commit, you can add a message to it to help organize and record the changes that go into the file/files. There are different versions of commits. A user can commit locally, which means all the changes that were saved are still on a user’s local machine; otherwise, the commit is pushed to the remote repository.
Revert: Revert is a term used to go back in time, or undo your work. This is commonly used when users want to return to a previous state in their code or project.
Push: The term push is used when you’re ready to send your local data to your remote repository.
Finish a changelist: The finish command is a command used in the WVS CLI that is used to complete your changes and send them to your remote repo.
Additional documentation
Read more on Getting started with the Desktop Client.
Read more on Getting started with the CLI.