Skip to content

Document unversioned installation URL #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
martincalander merged 1 commit into from
Aug 29, 2026
Merged

Document unversioned installation URL #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 7 additions & 13 deletions Documentation~/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,20 +83,15 @@ unverified work always appear.
## Add the Package with UPM

Open **Window > Package Management > Package Manager**, choose **+ > Install
package from git URL...**, and enter the tagged `v2.0.0` release:

```text
https://github.com/martincalander/GitSubmoduleManager.git#v2.0.0
```

Replace `v2.0.0` with another published release tag when upgrading. An
unqualified repository URL follows the mutable `main` branch and should be used
only for development or pre-release testing:
package from git URL...**, and enter:

```text
https://github.com/martincalander/GitSubmoduleManager.git
```

The unqualified URL follows `main`. To pin a published release instead, append
its tag to the URL.

## Team Clone Setup

Clone a project and initialize all registered submodules with:
Expand Down Expand Up @@ -155,16 +150,15 @@ changing only the revision is not sufficient:
```json
{
"dependencies": {
"com.martincalander.gitsubmodulemanager": "https://github.com/martincalander/GitSubmoduleManager.git#<renamed-release-tag>"
"com.martincalander.gitsubmodulemanager": "https://github.com/martincalander/GitSubmoduleManager.git"
}
}
```

Remove the old `com.essentials.gitpackagemanager` or
`com.martincalander.gitpackagemanager` key and let Unity regenerate
`Packages/packages-lock.json`. Replace `<renamed-release-tag>` with a published
tag that includes the Git Submodule Manager identity. No 1.x tag was published
from this repository; `v2.0.0` is the first tag under the current identity.
`Packages/packages-lock.json`. No 1.x tag was published from this repository.
Append a published tag only when the project needs a pinned package revision.

For a submodule installation, also coordinate the parent repository's gitlink
and `.gitmodules` path from either
Expand Down
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,15 @@ Windows, macOS, and Linux.

## Installation

Install the tagged `v2.0.0` release from **Window > Package Management > Package
Manager > + > Install package from git URL...**:
In **Window > Package Management > Package Manager**, choose **+ > Install
package from git URL...** and enter:

```text
https://github.com/martincalander/GitSubmoduleManager.git#v2.0.0
https://github.com/martincalander/GitSubmoduleManager.git
```

An unqualified repository URL follows the mutable `main` branch and is intended
only for development or pre-release testing.
This URL follows `main`. To pin a published release instead, append its tag to
the URL.

## Quick Start

Expand Down