Learning Documentation CommunityOpen ExchangeGlobal Masters Certification Partner Directory Ideas Portal

Submit application

Git for Shared Development Environments

Downloads73

954

Bookmark

This application is not supported by InterSystems Corporation. Please be notified that you use it at your own responsibility.

Details

Releases

Reviews

Issues

Articles

git-source-control

Server-side source control extension for Git on InterSystems' platforms

Prerequisites/Dependencies

IRIS instance with license key
Git 2.31.0+
OpenSSH 7.6+
InterSystems package manager (https://openexchange.intersystems.com/package/ObjectScript-Package-Manager)

Installation and Setup

Load this repository into IRIS from the community package registry.
```
zpm "install git-source-control"
```
Configure settings by running the following method and answering the prompts:
```
d ##class(SourceControl.Git.API).Configure()
```
If using VSCode: Set up isfs server-side editing. First, save your current workspace in which you have the code open. Then, open the .code-workspace file generated by VS Code and add the following to the list of folders:
```
{
    "name": "<whatever you want the folder to show up as in the project explorer view>",
    "uri": "isfs://<instance_name>:<namespace_name>/"
}
```

Basic Use

Studio

Add a file for tracking by right-clicking on it in the workspace/project view and choosing Git > Add. This same menu also has options to remove (stop tracking the file), discard changes (revert to the index), or commit changes.

You can browse file history and commit changes through a user interface launched from the top level Git > "Launch Git UI" menu item. There is also a page for configuring settings.

VSCode

The same right click menus as in Studio live under "Server Source Control..." when right-clicking in a file (in the editor) or on a file when exploring an isfs folder. The top level "source control" menu is accessible through the command palette or the source control icon in the top right of the editor.

Notes

Mapping Configuration

To specify where files should go relative to your repository root, add mappings via the "Settings" menu item. A mapping has three parts:

The file extension to use: e.g., CLS, MAC. As a special case for web application files, use "/CSP/" as the mapping.
A filter on the files of that type (e.g., a package name or web application folder)
The folder relative to the repo root that contains the item. This controls behavior for import and export.

This might look like:

Security

Unsecured (http) connections

You really should be connecting to IRIS over a secured (https) connection. If you're not, web pages in this extension will launch in an external browser, because constraints around session cookies keep them from working properly in VSCode.

Dubious Ownership

Newer git versions may produce output like:

fatal: detected dubious ownership in repository at 'C:/Your/Repo/Root' To add an exception for this directory, call: git config --global --add safe.directory C:/Your/Repo/Root

Set the environment variable GIT_TEST_DEBUG_UNSAFE_DIRECTORIES=true and run again for more information.

It is important for the namespace temp folder to be owned by the user IRIS runs as. (On Unix, commonly irisusr; on Windows, generally a designated service account or SYSTEM.) Setting this config flag is unlikely to actually help; just make sure the ownership is correct.

Interacting with Remotes

If you want to interact with remotes from VSCode/Studio directly (e.g., to push/pull), you must use ssh (rather than https), create a public/private key pair to identify the instance (not yourself), configure the private key file for use in Settings, and configure the public key as a deploy key in the remote(s).

IRIS Privileges

For developers to be able to run this extension, they'll need the USE privilege on %System_Callout.

Setting up multiple GitHub deploy keys on one machine

Assuming you have the local and remote repositories created,

Create your key pair using ssh-keygen.
Add the public key to GitHub.
You can try setting remotes with the URL your remote repository provides, but sometimes your firewall might cause issues and refuse the SSH connection. In that case, I've found that changing the remote URL to the following is helpful: ssh://git@ssh.github.com:443/<repo_owner>/<repo_name>.git
Copy the private key into 2 locations
1. <path to IRIS Instance storage>\mgr\<private key>
2. ~/.ssh/<private key>
Make sure to set the owner and permissions for the private key correctly. For Windows, go to where the private key is stored in IRIS and edit the owner to be the admin, disable inheritance and remove all access to the key to every user except the admin.
In git source control settings, set the path to the private key as the one in IRIS.
Change the default ssh command in the git config for your repository as: git config core.sshCommand 'ssh -i ~/.ssh/<private key name>'
Test the refresh button for the remote branches on the WebUI, fetch from the source control menu in Studio or VS Code, and git fetch in Git Bash. All 3 should work without any issues.

During Development

⚠️ Whenever any code in this project is updated outside the server (e.g. after every git pull), you have to run zpm "load <absolute path to git-source-control>". Otherwise, the changes won't be reflected on the server. However, if you load git-source-control via the InterSystems package manager and run git pull via the extension itself with the default pull event handler configured, it'll just work.

Tag version: 2.1.1

Released: 2023-02-24 19:16:50

Fixed:

Link from WebUI to Settings page works properly (#230)
No longer get a "permission denied" message on Linux (#231)
VSCode Web Views launch in external browser when connecting over unsecured connections (#227)
DTL/BPL editing through Studio reflected properly in source control (#241)
Plays nicely with interoperability "Deployment" features (#236)
errors rendering menus as a user with limited privileges (%Developer + Ens*)

Tag version: 2.1.0

Released: 2023-01-23 13:52:34

Added

Support for Caché/Ensemble 2016.2.3, 2017.1.2, 2017.2.1, 2018.1.0 and later.
Installation adds a Management Portal favorite for all users (https://github.com/intersystems/git-source-control/issues/209)
Improved configuration and defaults to simplify initial configuration (https://github.com/intersystems/git-source-control/issues/213)
If no name/email is specified, defaults to $username and $username@<hostname>

Fixed

"Import All" will properly recognize new files
"Import All" and "Export All" apply only to the current package manager context and disregard items outside that context
"Import All" treats "Other" document types (DFI, LUT, etc.) properly

Internal

Added CI script and tweaked unit tests to run properly in a container and bootstrap their own extension configuration
Tweaked various minor things under the hood to support use without the package manager and/or on older platforms

Tag version: 2.0.5

Released: 2022-12-02 16:17:37

Fixed

Tree/Commit links don't navigate
Slashes present in tree view

Security

File contents are properly escaped in tree view

Tag version: 2.0.4

Released: 2022-10-05 11:39:46

Fixed:

Handle UTF-8 characters in git commit messages

Tag version: 2.0.3

Released: 2022-09-07 13:20:08

Fixed:

Correctly detects filesystem mappings in a package manager context
Improved performance by removing redundant git status calls

Tag version: 2.0.2

Released: 2022-08-09 20:07:12

Fixed

#201: fix behavior with CSP files

Tag version: 2.0.1

Released: 2022-06-02 08:59:30

Changed the way we match mappings in NameToInternalName, modified and added new testcases by @isc-svelury in #199

Tag version: 2.0.0

Released: 2022-05-02 10:27:20

Release Notes

Breaking Changes

We don't need sc-list.txt anymore. We only use a global to maintain a list of tracked files that are in IRIS and Git.
Package (.pkg) and project (.prj) files will no longer be in source control. Instead, all the individual files in the package will be in source control. This means that the user can easily remove a single file from source control. See Feature 2 for an explanation on how it all works.
When we can't find a match for a file in the configured mappings, we no longer export the file.

Features

Uncommitted check on checkout:
- On branch checkout, the WebUI requests information about uncommitted changes from api/uncommitted and confirms that the user knows another user has uncommitted changes and that they will carry them over on checkout.
- This applies to checking out existing local and remote branches and creating new local branches.
Single file delete: If a package was in source control, then it was not possible to remove a single file or group of files from source control.
- For packages, both options — Add and Remove are displayed. We are no longer concerned with figuring out whether a package should be in source control - it never is!
- No packages or sub-packages should be added to source control. When the user adds a package to source control, all its files not already in source control get added.
- When the user removes a package from source control, all its files in source control will get removed.
- We don't have to worry about any weird edge cases this way and behavior is more consistent overall.
Navigation between Settings page and WebUI:
- There are buttons added to both pages to enable easy navigation.

Enhancements

Configurability for how the "%" symbol is changed on export of % classes.
Removed sc-list.txt from the project.
New files diff in Workspace: A diff for new files is now displayed in the WebUI Workspace.
NoFolders mappings:
- Added granularity: The NoFolders setting can now be applied to specific packages (instead of covering all files of a type).
- The user can now add paths to NoFolders mappings. This way, all files that match the mapping will be stored with no further sub-folder creation at the specific path root.

Bug Fixes

Changed the name of the % class replace field to be correct.
Added newlines to outputs wherever necessary for better formatting.
NameToInternalName() tries to get internal names for all file types that have mappings.
NameToInternalName() no longer returns an empty string for a % class.
Name() now matches mappings correctly.
No more Bifrost: Got rid of the many lines that were created after the first commit because of a bug in the way we were getting substrings.
Commit graph does not flash and fill up the whole Commit History pane anymore.
Stash drop now properly drops the stash entry.
Fixed an issue where the NoFolders toggle on a new mapping triggered the toggle on the first mapping instead of the clicked toggle.
Centered the Settings page and added input validation to the form fields.
Removed entries from ^SYS("SourceControl","Git","items") in ImportRoutines() if we find that the file has been deleted.
RefreshUncommitted() now uses git status to prune out files that were committed through means other than the Commit changes option is the Server Source Control menu. It also adds records to track uncommitted files, if applicable. This should help with ensuring that multiple users never edit the same file at the same time because of a missing record of change. It will also help with cases where a user might be blocked from editing a file because of a stale record in the uncommitted queue.
We don't try to source control ZPM documents.

Documentation

Updated the Help modal on the WebUI to include up-to-date screenshots and documentation for all new features.

Tag version: 1.2.0

Released: 2021-12-16 08:28:17

Git add packages by @isc-svelury in #79
Removing from source control now works by @isc-svelury in #80
Queue filter by @isc-svelury in #82
compatibility fix for IE + minor bugfix by @isc-svelury in #83
Reload page on login expiration by @isc-svelury in #84
String.substr() is deprecated and substring() works a little differently by @isc-svelury in #87
Updated README with OpenSSH requirement by @isc-svelury in #89
Merge minor UX improvements by @isc-svelury in #94
Automatically stage any changes to sc-list.txt and note in README by @isc-svelury in #96
Stash list, pop, apply, drop; stash files from workspace by @isc-svelury in #95
Background color fix by @isc-svelury in #99
Automatically refresh the list of files in Working Copy after stashing by @isc-svelury in #98
includes is not supported by IE. Use indexOf instead. by @isc-svelury in #97
Preserve filenames for AbstractDocuments by @isc-svelury in #100

Tag version: 1.1.3

Released: 2021-11-15 16:17:01

Miscellaneous bug fixes, most notably for UI operations on some (all?) Linux platforms

Tag version: 1.1.2

Released: 2021-11-02 13:16:39

Fixes for better usability in portal-based interoperability editors

Tag version: 1.1.1

Released: 2021-11-01 05:21:04

Fixing completely broken UI on Linux
Clearer settings around git path when on git is available via PATH
Expose git version in CLI and settings UI
Popper.js downgrade for proper compatibility

Tag version: 1.1.0

Released: 2021-10-25 22:10:43

New features for branch management

Tag version: 1.0.0

Initial Release - Virtual Summit 2021

Nicholai Mitchko27 February 2023

Fantastic Plugin - Developer ver responsive

I've used git-source-control many times in my deployments for dev and test environments. It truly helps automate the source control activities when using a git repo and remote repository. Tim has pushed changes quickly when I run into odd-ball use cases (such a limited permissions)

IPM installation

zpm "install git-source-control"

Rating

(1)

Git for Shared Development Environments

What's new in this version

git-source-control

Prerequisites/Dependencies

Installation and Setup

Basic Use

Studio

VSCode

Notes

Mapping Configuration

Security

Unsecured (http) connections

Dubious Ownership

Interacting with Remotes

IRIS Privileges

Setting up multiple GitHub deploy keys on one machine

During Development

Fixed

Security

Release Notes

Breaking Changes

Features

Enhancements

Bug Fixes

Documentation