Plainform

Plainform periodically releases updates with new features, bug fixes, and improvements.

To keep your project up to date with the latest changes from the upstream repository, you need to pull updates into a new branch, merge them into your project, and resolve any merge conflicts that may arise. This process ensures your codebase stays current while preserving your customizations.

Follow the steps below to pull updates from the Plainform repository safely and efficiently.

Pulling Updates

Set Up the Upstream Repository

Add the Plainform repository as a remote to pull updates from. Run this command in your project’s root directory:

git remote add upstream https://github.com/PlainformDev/starter-kit-v1.git

Create a New Branch for Updates

Always pull updates into a new branch to avoid disrupting your main branch. Create and switch to a new branch:

git checkout -b update-branch

Pull Updates from Upstream

Fetch and merge the latest changes from the upstream repository’s main branch:

git fetch upstream

git merge upstream/main

This pulls the latest commits from Plainform Dev into your update-branch.

Resolve Merge Conflicts (If Any)

If your project has customizations, merge conflicts may occur when pulling updates. Git will pause the merge and mark conflicting files. To resolve conflicts:

Open the affected files in your code editor (e.g., VS Code). Git marks conflicts with <<<<<<<, =======, and >>>>>>>.
Review each conflict, keeping your custom changes where necessary and incorporating upstream updates.
After resolving conflicts, mark the files as resolved:

git add <file-name>

Complete the merge:

git commit

Test your application locally (npm run dev) to ensure everything works as expected.

Merge Updates into Your Main Branch

Once conflicts are resolved and the app is stable, merge the updates into your main branch:

git checkout main

git merge update-branch

Push the updated main branch to your repository:

git push origin main

6. Clean Up

Delete the update branch if no longer needed:

git branch -d update-branch

Important Notes

Backup Your Code: Before pulling updates, commit or stash any uncommitted changes to avoid losing work.
Check Release Notes: Review Plainform release notes (in the repository or documentation) to understand changes and potential impacts.
Handle Dependencies: After merging, run npm install to update dependencies if the package.json file has changed.
Test Thoroughly: Always test your application after merging to catch issues introduced by updates or conflict resolutions.
Merge Conflicts: Conflicts are common if you’ve customized files like app, components, or config. Take care to preserve your changes while integrating updates.

By following these steps, you can keep your Plainform project up to date while maintaining your customizations. For further assistance, refer to the Git documentation or contact our support team.

Pull Updates

On this page