Skip to content

RELEASING.md

Latest commit

 

History

History
36 lines (24 loc) · 2.09 KB

RELEASING.md

File metadata and controls

36 lines (24 loc) · 2.09 KB
Raw

Publishing an update to UI Animation Player

Branch What it is
main All internal changes. Users don't see this.
release What projects install. It only changes when published. It's the repo's default branch, so it's what visitors see first.

Publishing means copying main into release.

Because release is the default, GitHub picks it as the target of every new pull request. Any pull request that isn't a release should target main: check the base dropdown when opening one.

Publishing

  1. Open this link: https://github.com/rmfandyplayz/UnityUIAnimationTools/compare/release...main
    • If it says "There isn't anything to compare", release is already up to date and there's nothing to publish.
  2. Look over the commits and changed files it lists. That's exactly what's about to go out.
  3. Click Create pull request. Give it a title like Release 1.0.2. The version number is in DOTweenAnimationPlayer/package.json on main. Click Create pull request again.
  4. Click Merge pull request, then Confirm merge.
    • The green button must say Merge pull request. If it says Squash and merge or Rebase and merge, click the little arrow beside it and choose Create a merge commit. The other two can make the next release run into conflicts.

The pull request stays on the repo's Pull requests → Closed tab, which doubles as a release history.

After publishing: catch main up

The merge in step 4 makes a commit that only release has, so GitHub will show main as "1 commit behind release". To clear it, make a PR that merges release into main. It only moves main forward to the merge commit; nothing is rewritten. Skipping it does no harm, and the next release works either way (this is purely optional).

Updating a project

In Unity:

  1. Window → Package Manager.
  2. Under In Project, select DOTween UI Animation Player.
  3. Click Update at the top right.

The refresh button under the package list does not check for these updates. It only looks at Unity's own packages. Use Update.