Skip to content

Finalize Nexus Unity 1.4.1 release docs #41

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
Daliys merged 1 commit into from
Jun 12, 2026
Merged

Finalize Nexus Unity 1.4.1 release docs #41

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
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ All notable public changes to Nexus Unity are documented here.

## [Unreleased]

## [1.4.1] - 2026-06-11
## [1.4.1] - 2026-06-12

### Fixed
- Added the missing folder `.meta` files for `docs/`, `docs/assets/`, and `Editor/tests/`. These folders were published without their folder-level metas, so a fresh package install logged "no meta file ... will be ignored" warnings and skipped the folders.
Expand Down
4 changes: 2 additions & 2 deletions DOCUMENTATION.MD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ Before release, maintainers should run a public API stress audit that compares r

Nexus Unity follows semantic versioning for public releases, but the development branch should not bump the package version for every merged fix. Keep `package.json` and visible docs at the latest shipped public version until a release is being prepared.

Unity Package Manager requires `MAJOR.MINOR.PATCH` values in `package.json`, and GitHub release tags and titles use the same semantic version. Use forms like `1.4.0` for the package version, `v1.4.0` for tags, and `1.4.0` for release titles.
Unity Package Manager requires `MAJOR.MINOR.PATCH` values in `package.json`, and GitHub release tags and titles use the same semantic version. Use forms like `1.4.1` for the package version, `v1.4.1` for tags, and `1.4.1` for release titles.

During normal development:

Expand All @@ -224,4 +224,4 @@ During release preparation:
- Choose the next semantic version based on accumulated changes.
- Move `[Unreleased]` entries into the new dated release section.
- Update `package.json`, README badges/install examples, `DOCUMENTATION.MD`, and `API_REFERENCE.MD`.
- Tag the release with the matching semantic GitHub version, for example `v1.4.0` for package version `1.4.0`.
- Tag the release with the matching semantic GitHub version, for example `v1.4.1` for package version `1.4.1`.
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ For integration tests, open the Unity project, start the Nexus Unity server from

Do not bump `package.json` for every change while development is unreleased. Keep the package at the latest public release version, currently `1.4.1`, and record user-visible work under `[Unreleased]` in `CHANGELOG.md`.

When maintainers prepare a release, move the accumulated `[Unreleased]` entries to the new version section, update `package.json` and the visible version strings in `README.md`, `DOCUMENTATION.MD`, and `API_REFERENCE.MD`, then tag the release. Unity Package Manager and GitHub releases both use semantic `MAJOR.MINOR.PATCH` versions such as `1.4.0` and `v1.4.0`. Reserve patch bumps for urgent compatible hotfixes.
When maintainers prepare a release, move the accumulated `[Unreleased]` entries to the new version section, update `package.json` and the visible version strings in `README.md`, `DOCUMENTATION.MD`, and `API_REFERENCE.MD`, then tag the release. Unity Package Manager and GitHub releases both use semantic `MAJOR.MINOR.PATCH` versions such as `1.4.1` and `v1.4.1`. Reserve patch bumps for urgent compatible hotfixes.

## Community

Expand Down
6 changes: 3 additions & 3 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This checklist is for publishing `com.forkhorizon.nexus.unity` as an open source
- Package id: `com.forkhorizon.nexus.unity`
- Public repository: `https://github.com/ForkHorizon/NexusUnity.git`
- License: `GPL-3.0-only`
- Current public version: `1.4.0`
- Current public version: `1.4.1`
- Minimum Unity version: `6000.0`

## Development Versioning
Expand All @@ -27,7 +27,7 @@ Use `CHANGELOG.md` as the source of truth during development:
- Keep compatibility notes and migration guidance in the docs while the work is unreleased.
- Prepare the next semantic version only when cutting a release branch or release commit.

Unity Package Manager requires `MAJOR.MINOR.PATCH` in `package.json`, for example `1.4.0`. GitHub release tags, titles, and announcements use the same semantic version: `v1.4.0` for tags and `1.4.0` for release titles.
Unity Package Manager requires `MAJOR.MINOR.PATCH` in `package.json`, for example `1.4.1`. GitHub release tags, titles, and announcements use the same semantic version: `v1.4.1` for tags and `1.4.1` for release titles.

When preparing the release, choose the version by semantic versioning:

Expand All @@ -39,7 +39,7 @@ When preparing the release, choose the version by semantic versioning:

1. Verify `Assets/NexusUnity/package.json`:
- `name` is `com.forkhorizon.nexus.unity`.
- `version` matches the Unity package version, such as `1.4.0`.
- `version` matches the Unity package version, such as `1.4.1`.
- `license` is `GPL-3.0-only`.
- Repository, documentation, changelog, and license URLs point to the public repository.
2. Verify docs:
Expand Down
Loading