NOTE: Distribution methods for the enterprise plugin's Git bundles is still TBD
You will receive these plugins as a Git bundle — a single file that behaves like a normal Git repository. You clone it once, make your own changes, and each time we ship an update we send you a small bundle file that you pull in. Our updates merge on top of your changes, exactly like pulling from a shared repository — but you never need access to our GitHub.
You’ll receive two kinds of files from us:
| File | When | Purpose |
|---|---|---|
<plugin>-<version>.bundle | Once, to get started | The full plugin (complete history) |
<plugin>-<from>-to-<version>.bundle | Each new release | A small update you pull in |
Examples below use Auth Connect starting from
auth-connect-8.0.0.bundle. Your filenames will match the plugin and versions we send.
Prerequisites
- Git installed (
git --versionto check).
1. First-time setup — clone the full bundle
Clone the full bundle we sent you. This creates a working copy on the customer-release branch with the complete plugin source.
git clone auth-connect-8.0.0.bundle my-copy cd my-copy
Stay on the customer-release branch — it’s the branch the clone leaves you on, and the one our updates merge into.
2. Make your changes
Work normally. Edit, add, and commit on the customer-release branch.
# (example change) echo "my change" > CUSTOMER_TEST.md git add CUSTOMER_TEST.md git commit -m "my local change"
3. Apply an update we send you
Before pulling, make sure you’re on the right branch and your work is committed. A pull merges our changes into your copy, and Git will refuse if you have uncommitted edits in the way.
git branch --show-current # should print: customer-release git status # should say: nothing to commit, working tree clean
If git status shows uncommitted changes, either commit them (as in step 2) or set them aside temporarily:
git stash # set uncommitted work aside # ... run the pull below ... git stash pop # reapply your work afterward
Then pull the update. Point at wherever you saved the file — the filename changes with each release.
# (example: the next release's update would be named like this) git pull --no-rebase --no-edit /path/to/auth-connect-8.0.0-to-8.1.0.bundle customer-release
4. Confirm it worked
You should see a merge that includes both your change and our update.
git log --oneline --graph -5
If you get a merge conflict
A conflict only happens when your edits and our update touch the same lines. It’s a normal Git merge conflict — nothing bundle-specific:
git status # see which files conflict # edit the files to resolve the conflicts git add <resolved-files> git commit # completes the merge
Notes
- Keep working on
customer-release. All updates are pulled into this branch. - Each update is a separate file. Save the bundle we send, then run step 3 pointing at it. You can delete old update bundles once pulled.
- You keep everything you’ve pulled. The files you’ve received remain yours; future updates simply build on top of them.
Comments
0 comments
Article is closed for comments.