unional / jspm-p4

jspm registry for perforce

jspm-p4

jspm registry endpoint for Perforce.

What you need

1. The ability to create labels
2. The ability to create workspace

Usage

Create a workspace (P4CLIENT) that points to the root of your repository. For example you have //depot/jspm-repo that serves as the root of your repository, then you create a workspace such as //depot/jspm-repo/... //yourworkspace/... and point it to /home/you/jspm-registory (it doesn't need to name as jspm-registory, any name would be fine).

While you don't have to do a p4 sync on the registory, you do need to at least mkdir jspm-registory for p4 to work correctly.

After you do that, you can then go to your project and do the following (replacing {myEndpoint} and {myModule}):

npm install jspm-p4
jspm registry create {myEndpoint} jspm-p4

# Get lastest labeled/versioned module
jspm install {myEndpoint}:{myModule}

# Get specific version
jspm install {myEndpoint}:{myModule}@x.y.z

# Get latest change. `dev` is a special internal tag
jspm install {myEndpoint}:{myModule}@dev

jspm-p4 relies on p4 labels to manage versions. Similar to what you need to do on git/GitHub, when you have a module that is ready to publish, do the following:

1. Update version in package.json (this doesn't have real effect, but it is a good practice to keep it consistent with your label).
2. Tag the folder on specific revision/changelist with a label that follows the semver convention (create the label if needed).
   1. Do not tag on the revision/changelist, you will get only the modified files.

To avoid unexpected behavior (mess ups), do not submit changes from multiple modules in the same revision. Check them in separately. That's the right thing to do anyway.

Design Direction

Perforce is a centralized VCS, and it works with a workspace concept. So to use it as a repository for jspm, I rely on checking out the repository locally. It is the same approach as git-p4.

Perforce labels can be applied to multiple revisions, so to create a unique hash for each package and versions, I use the hash of packageName + label.

License

MIT