Make and submit changes to your project

This Hello world tutorial shows you how to create and submit changelists to the hello-world-demo-fork. When you make changes to the cloned copy of your project, the files that you change are tracked in a changelist, where you can also lock or checkout the files that you’re working on. When you’re done making changes, you can commit the local changes to your project’s repository by submitting the changelist.

This tutorial gives your instructions for both the WVS Desktop Client and the wvs command line tool. The WVS Desktop Client offers a simplified workflow for non-technical members of your team. You can also create and submit changelists by using the WVS plugins for Unreal and Unity and 3rd party Git clients.

Prerequisites

You have completed the Fork and clone a project tutorial.

Create a changelist

To create a new changelist by using the WVS Desktop Client, perform the following steps:

  1. Open the WVS Desktop Client.
  2. Click My projects.

  3. Select the hello-world-demo-fork project and click Switch project.

    Swith projects.
  4. Click New Changelist.
  5. In the New Changelist field, enter Update README as the changelist name.

  6. In the Files to be selected box, select README.md to check it out.

    Note: When you check out a file, that file becomes locked and cannot be updated by others until you check it back in.

  7. Click Start changelist.

    Create a changelist.

    The changelist is created and you are taken to the Current changelist page in the Desktop Client.

To create a new changelist by using the `wvs` CLI, run the following command: 

wvs changelist begin "Update README"

The command returns something like the following: 

C:\wvsProjects\hello-world-unity-mobile-tutorial>wvs changelist begin "Update README"
------------------------------------------------------------------------
   Validating push branch...
------------------------------------------------------------------------
Your branch is up to date with 'origin/main'.
Switched to branch 'main'
OK
------------------------------------------------------------------------
   Getting latest from server...
------------------------------------------------------------------------
From wvs.io:wvsuser/hello-world-unity-mobile-tutorial
* branch            main       -> FETCH_HEAD
= [up to date]      main       -> origin/main
Already up to date.
OK
------------------------------------------------------------------------
   Creating changelist temporary work branch...
------------------------------------------------------------------------
Deleted branch wvs-stage (was 6ccad36).
Switched to branch 'wvschgl_7b6e1cf8-ff28-44ad-9c7b-aad9734d5449'
OK

C:\wvsProjects\hello-world-unity-mobile-tutorial>_

To lock the `README.md` file, run the following command: 

wvs changelist grab README.md

The command returns something like the following: 

C:\wvsProjects\hello-world-unity-mobile-tutorial>wvs changelist grab README.md
Locked README.md
OK

C:\wvsProjects\hello-world-unity-mobile-tutorial>_

Make a change to README.md

  1. Open your local project directory. If you’re using the WVS Desktop Client, you can click on the folder icon.
  2. Open the README.md file with any text editor.
  3. Make a change to the README.md file and save the changes.

Submit the changelist

To submit a changelist by using the WVS Desktop Client, perform the following steps:

  1. Open the WVS Desktop Client

  2. In the navigation panel, click Current changelist.

    README.md is listed under Files modified.

  3. Ensure that README.md is selected so that it’s included in the changelist.
  4. Click Commit changelist.

  5. When prompted, click Push changelist.

    README.md is checked back in once the changelist is submitted so that others can make changes to it.

Swith projects.

To submit a changelist by using the `wvs` CLI, perform the following steps: 

wvs changelist finish

The command returns something like the following: 

C:\wvsProjects\hello-world-unity-mobile-tutorial>wvs changelist finish
------------------------------------------------------------------------
    Committing work to temporary work branch...
------------------------------------------------------------------------
OK
------------------------------------------------------------------------
    Updating branch 'main' from server...
------------------------------------------------------------------------
OK
------------------------------------------------------------------------
    Merging branch 'main' to local staging branch...
------------------------------------------------------------------------
OK
------------------------------------------------------------------------
    Merging temporary work branch to local staging branch...
------------------------------------------------------------------------
OK
------------------------------------------------------------------------
    Merging local staging branch to branch 'main'...
------------------------------------------------------------------------
Your branch is up to date with 'origin/main'.
Switched to branch 'main'
------------------------------------------------------------------------
    Pushing branch 'main' to server...
------------------------------------------------------------------------
Pushing to wvs.io:wvsuser/hello-world-unity-mobile-tutorial.git
To wvs.io:wvsuser/hello-world-unity-mobile.git
 = [up to date]      main -> main
updating local tracking ref 'refs/remotes/origin/main'
Everything up-to-date
Deleted branch wvschgl_7b6e1cf8-ff28-44ad-9c7b-aad9734d5449 (was 6ccad36).
------------------------------------------------------------------------
    Unlocking all relevant files...
------------------------------------------------------------------------
Unlocked README.md
OK

C:\wvsProjects\hello-world-unity-mobile-tutorial>_

README.md is checked back in once the changelist is submitted so that others can make changes to it.

Next steps

Report a problem with this page.