https://github.com/starikcetin/git-upm-publisher-2

Automate UPM package releases for Git repositories containing Unity plugins.
https://github.com/starikcetin/git-upm-publisher-2

cli command-line command-line-tool typescript unity unity-package unity-package-manager unity3d upm upm-publisher

Last synced: about 1 month ago
JSON representation

Automate UPM package releases for Git repositories containing Unity plugins.

• Host: GitHub
• URL: https://github.com/starikcetin/git-upm-publisher-2
• Owner: starikcetin
• License: mit
• Created: 2020-02-22T19:21:53.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-10-19T22:32:40.000Z (about 1 year ago)
• Last Synced: 2024-10-11T06:13:12.777Z (about 1 month ago)
• Topics: cli, command-line, command-line-tool, typescript, unity, unity-package, unity-package-manager, unity3d, upm, upm-publisher
• Language: TypeScript
• Homepage: https://www.npmjs.com/git-upm-publisher
• Size: 451 KB
• Stars: 13
• Watchers: 3
• Forks: 1
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![npm](https://img.shields.io/npm/dt/git-upm-publisher?label=npmjs&style=plastic)](https://www.npmjs.com/package/git-upm-publisher)

# git-upm-publisher-2

Continuation of the [git-upm-publisher](https://github.com/starikcetin/git-upm-publisher), which never worked as it was supposed to.

Written in Typescript this time.

# Install

```shell

npm i -g git-upm-publisher

```

**Make sure to delete the python version if you were using it:**

```shell

pip uninstall git-upm-publisher

```

# Usage

Navigate to the folder with the `package.json`, and run `gup`.

## Command Line Parameters

| Parameter   | Alias | Type    | Description                                                                                       |

|-------------|-------|---------|---------------------------------------------------------------------------------------------------|

| --help      |       | boolean | Show help                                                                                         |

| --version   |       | boolean | Show version number                                                                               |

| --remote    | -r    | string  | Name of the remote where UPM package branch resides or will reside. Defaults to "origin".         |

| --branch    | -b    | string  | Name of the branch to publish the UPM package to. Defaults to "upm".                              |

| --force     | -f    | boolean | Disable checks and execute snapshot with force flag.                                              |

| --noAuthor  | -a    | boolean | Disable overriding the commit author for auto-commits made by this tool.                          |

| --noPush    | -n    | boolean | Disable auto-pushing of the upm branch to the origin.                                             |

| --noPull    | -l    | boolean | Disable pulling of the UPM package branch before and after the publishing process.                |

| --noCommit  | -c    | boolean | Disable the auto-commit before publishing that includes the version change in the 'package.json'. |

| --package   | -p    | string  | Skip searching and use this package.json path (must include 'package.json').                      |

| --tagPrefix | -t    | string  | A prefix for the git tag.                                                                         |

# Licence

MIT license. Refer to the [LICENSE](LICENSE) file.

Copyright (c) 2020 starikcetin