Commit changes
In Designer, a commit represents a snapshot of your work in your current branch. A commit contains a unique identifier that helps you track changes to your pipelines over time. Performing a commit lets you save your changes in your local repository.
Property | Description |
---|---|
Branch | This is the checked-out branch where you've made changes and intend to capture the snapshot. You can't edit this—you must switch branches to make a commit on another branch. |
Changes | This is the list of files with uncommitted changes. It includes information such as file type, file name, file path, and the status of the file. The different statuses are New, Modified, and Deleted. Click the Compare changes icon in a file's row to compare the local changes made in this file to the previous commit. |
Message | A text field to enter a brief description of the changes you've made for this commit. |
How to commit
Once you have made changes to your branch, a notification icon appears next to the name of your branch, to indicate that there are changes to commit. The number of uncommitted changes is displayed on the drop-down menu. The notification disappears after you commit your changes.
Pulling from remote can overwrite any uncommitted changes if the remote changes are in conflict with your uncommitted changes. To ensure you don't lose any work, commit your changes before you pull. Otherwise, you can do a Reset to go back to your last commit.
Follow the steps below to commit your changes:
- Click the name of your branch on the project bar.
- Click Commit changes in the drop-down menu. The number displayed next to this option shows the number of uncommitted changes on your local branch.
- In the Commit changes dialog, in the Message field, add a brief description of the changes you've made for this commit so that other collaborators can understand what changes you've made.
- You can also use Copilot to write your commit messages. Click Generate with Copilot and Copilot will summarize the changes in the commit. Copilot generates commits using the Conventional Commits format.
- Click Commit to save your snapshot. Otherwise, click Cancel to cancel your commit.
If there are no changes since your last commit, a message is displayed to say that there are no changes to commit.
Note
The Commit action will commit all pipelines in your current branch, preserving the pipeline folder structure. However, it will not commit empty folders; these will disappear from the pipeline list.
View commit history
After you have made one or more commits, you can use the View commit history action to see the commits you have made in your current branch. You can view the last 100 commits made in your current branch in Designer. You will need to use your external Git provider to view any commits older than this.
To view your commit history:
- Click the branch menu on the project bar.
- Click View commit history in the drop-down menu.
A dialog will open containing the following information about the commits made in this branch:
- Commit hash: A unique identifier for the commit.
- Commit message: The commit message for the commit, written by the user making the commit or generated automatically.
- Timestamp: The date and time that the commit was made.
- Commit author: The user who committed the changes.