* Initial Structure Setup * Add SMTP Configuration Content * Add ToolJet Plan Content * Update ToolJet Plan Docs * Update SMȚP Configuration * Add Organization Overview * Update SMTP Cofig * add licensing structure * revert AppCard.jsx * revert AppCard.jsx * Revert AppMenu.jsx * Revert Folders.jsx * Revert ManageGroupPermissionResources.jsx * revert mixins.scss * revert tabler.scss * revert tabler.scss * revert tabler.scss * revert tabler.scss * add: white label doc * Update overview * add: instances and workspaces * revert AppCard.jsx * revert changes from EditVersionModal.jsx * Revert Changes * Delete Extra File * fix: comments * update interlink * fix: multiple instance content * tj deployment beta * update tj deployment beta * Update Email Server Beta * Update Overview * update setup email communication * Update Licensing * Update overview and self hosted docs * Update self hosted beta * Update Licensing * minor improvments * update link * Update folder name * minor updates * Update Self Hosted * Update Cloud and Overview * Minor Updates and add Mailgun Screenshot * Change beta folder structure and add sendgrid screenshot * update setup tj folder * Replicate changes to 3.0.0-LTS * Add overview and onboard user structure in beta * Add Overview for User Management and Access Control * Add Invite User * first draft - bulk invite, archive, self signup * update: intance-workspace-whitelabelling * fix: workspace-whitelable doc * minor update in invite user * Update Onboarding and Offboarding of Users - 03/01 * Add structure for authentication and rbac in beta * update super admin file structure * add super admin content * Update overview page * Overview for onboard and offboard user * minor edit overview page * Update Invite User * Update Bulk Invite User * updated archive user * Update onboarding and offboarding * Content Update * Update Super Admin Structure * Update Super Admin * User Roles Content * Custom Groups Content * Granular Access Control [WIP] * Add SSO Structure * github sson 1 * github sso * Google SSO * ldap * grammatical improvement * Feedback Updates 1 * complete RBAC * sso update * SSO LDAP SAML OIDC * OIDC Setup * Google OIDC * Update LDAP and SAML Intro * Update Profile Management Structure * Update Access Control Docs * Update Custom Groups * feat: authentication * OIDC - Okta * feat: cloud auth * fix: overview typo * fix: selfhosted auth titles * Group Sync Structure * User Metadata * [WIP] OIDC Group Sync * OIDC Group Sync * Update use case example in user metadata * Remove password management section * Update reset password * add: retry limit in password login * Docs feedback update * OIDC Group Sync Docs * oidc grp sync * Custom Group * access control * Profile Management Structure * edit user details and reset password * profile settings * Development Lifecycle Structure * [WIP] Version Control * [WIP] Rollback * Update GitSync Structure * WIP GitSync * Copy GitSync from the Develop * Update version control as per feedback * wip: release * release and rollback * GitSync * GitSync * feat: self-hosted and cloud * gitsync backup docs * [WIP] GitSync * GitSync Backup * share app ideation * Share Application * WIP Audit Logs * WIP Okta SAML * wip - okta saml * Okta SAML * Audit Logs * Git Push and Pull * GitSync Backup * Release Management * GitSync Config * gitsync custom branch * Workspace Constants * Workspace Variables * Update License * update: images and css classes * update: images * update: envs * update: images * Img Update till Invite User * update: removed cloud from Dev Life cycle * feat: custom domain * fix: formatting - custom domain * update: workspace doc * metadata img update * Images till Onboard and Offboard * SSO Images * Image Update GitSync * fix: naming * delete sql backup * update: images * Add ToolJet API * Enhance Nav Bar * Update development lifecycle overview * update: images * Nav Bar Update * fix: feedback * Update FAQ dropdown * feedback update * Content Update * fix: images * fix: platform overview image * Update Grammar and Links till Onboard Users * Fix links * Update Self Singup Screenshot * Fix interlinking * Fix GitSync Interlinks * update: interlinking * Delete Old Docs Beta * Delete Old Files from LTS * Replicate Files in LTS * Update Home Page * fix workspace login link * fix links * Deploy ToolJet --------- Co-authored-by: PriteshKiri <pritesh.d.kiri@gmail.com>
5.9 KiB
| id | title |
|---|---|
| push | Push Changes to Git Repo |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
Once the GitSync feature is configured, you can start pushing changes to the git repository on following points:
- App Creation
- Manual Commit Using GitSync Button
- Auto Commit on App Rename
- App Version Update
- Auto Commit on Promoting Environment
- App Deletion
App Creation
Whenever you create a new app, you will see an option to select the Commit changes. If you select the commit changes option, the changes will be committed to the git repository.
Note: If the app name is same as the name of an existing app in the git repo, it will overwrite the existing app in the git repo.
<img style={{ marginBottom:'15px' }} className="screenshot-full" src="/img/gitsync/commitchanges.png" alt="GitLab SSH Key" />
Selecting the Commit changes option will create a new commit in the git repository. The commit message will be App creation and the author will be the user who created the app.
During app creation, a .meta folder is generated, containing a meta.json file with details of the last commit. Then, an app folder is also created, storing v1.json, which holds app-specific details of v1 version.
<TabItem value="GitHub" label="GitHub">
<img className="screenshot-full" src="/img/gitsync/firstcommit.png" alt="GitSync" />
</TabItem>
<TabItem value="GitLab" label="GitLab">
<img className="screenshot-full" src="/img/gitsync/gitlab/author.png" alt="GitSync" />
</TabItem>
Manual Commit Using GitSync Button
Whenever a user makes a change in an app, they can make a commit to the git repository by following these steps:
-
After making the changes, click on the GitSync button on the topbar.

-
On clicking the GitSync button, a modal will open with the option to enter the commit message.

-
Enter the commit message and click on the Commit changes button to commit the changes to the git repository.
Along with the commit message, the user can also see the connected Git repo URL and the last commit details. Last commit details helps the user to know the last commit message, author, date, and time. This helps the user to know the last commit details and make the commit message accordingly.
Once the changes are committed, the user can see the commit message, author, and date in the git repository.
<TabItem value="GitHub" label="GitHub">
<img className="screenshot-full" src="/img/development-lifecycle/backup/gitsync/github-commit.png" alt="GitSync" />
</TabItem>
<TabItem value="GitLab" label="GitLab">
<img className="screenshot-full" src="/img/gitsync/gitlab/lastcommitmsg.png" alt="GitSync" />
</TabItem>
Auto Commit on App Rename
Whenever an app is renamed, the changes will be automatically committed to the git repository. The commit message will be App is renamed and the author will be the user who renamed the app. Similarly an auto commit is generated whenever the version is renamed.
<TabItem value="GitHub" label="GitHub">
<img className="screenshot-full" src="/img/gitsync/rename.png" alt="GitSync" />
</TabItem>
<TabItem value="GitLab" label="GitLab">
<img className="screenshot-full" src="/img/gitsync/gitlab/apprename.png" alt="GitSync" />
</TabItem>
App Version Update
Whenever a user creates a new version of an app, there will be an option to select Commit changes. If the user selects commit changes option, the new version of the app will be committed to the git repository and the old version will be overridden.
<img style={{ marginBottom:'15px' }} className="screenshot-full" src="/img/gitsync/gitlab/newversion.png" alt="GitLab SSH Key" />
The JSON file in the app folder will be replaced with the new version of the app, the meta.json file in the .meta folder gets updated with the new version id and version name. The commit message will be Version creation and the author will be the user who created the new version of the app.
<TabItem value="GitHub" label="GitHub">
<img className="screenshot-full" src="/img/gitsync/replace.png" alt="GitSync" />
</TabItem>
<TabItem value="GitLab" label="GitLab">
<img className="screenshot-full" src="/img/gitsync/gitlab/newversion1.png" alt="GitSync" />
</TabItem>
Auto Commit on Promoting Environment
When you promote an environment, from Development to Staging, the changes will be automatically committed to the git repository. The commit message will be <version_number> Version of <app_name> promoted from <source_environment> to <destination_environment>. The author will be the user who promoted the environment. When you promote an environment, from Staging to Production, no changes will be committed to the git repository.
<img style={{ marginBottom:'15px' }} className="screenshot-full" src="/img/gitsync/promoted.png" alt="GitSync" />
This option can be enabled or disabled from the Configure git tab on the Workspace settings page. By default, this option is disabled.
App Deletion
Whenever a user delete an app from the workspace, the app will not be deleted from the git repository. The app will be available in the git repository in the same state as it was before the app was deleted.