Skip to content

Commit

Permalink
Merge pull request #24 from asasine/release/0.2.0
Browse files Browse the repository at this point in the history
Updated versions to v0.2.0 and updated release guide
  • Loading branch information
asasine authored Feb 19, 2022
2 parents f0740dd + 35ad5d1 commit fda4239
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 17 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Installing with NPM enables easier updates through the Unity Package Manager and
1. Open the [Unity Package Manager](https://docs.unity3d.com/Manual/upm-ui.html) window
1. In the top bar, change the packages to `Packages: In Project`
1. Select `BehaviorTree.NET`
1. In the bottom bar, click `Update to v0.1.1`
1. In the bottom bar, click `Update to v0.2.0`

### Install from Git URL
Installing from a Git URL allows you to fully customize which version of the package you use. If you are forking the package repository and not releasing on NPM, or are developing smaller features and bug fixes, you may find this approach useful.
Expand All @@ -38,7 +38,7 @@ Installing from a Git URL allows you to fully customize which version of the pac
1. In the dropdown, select `Add package from git URL` from the add menu
1. In the text box, enter the GitHub URL of this package: `https://github.com/asasine/BehaviorTree.NET.git`
- You may also specify releases using tags
- For example, targeting v0.1.1 would use the URL `https://github.com/asasine/BehaviorTree.NET.git#v0.1.1`
- For example, targeting v0.2.0 would use the URL `https://github.com/asasine/BehaviorTree.NET.git#v0.2.0`
- You can find all releases listed [here](https://github.com/asasine/BehaviorTree.NET/releases)
- More information on specifying git references is available in the [Unity Manual](https://docs.unity3d.com/Manual/upm-git.html#revision)
1. In the text box, click `Add`
Expand All @@ -52,4 +52,3 @@ Installing from disk lets you use a clone of the repo. This is useful if you are
1. In the file explorer, navigate to the cloned repository and open the `package.json` file

Install the package into Unity as a local or git package by following the steps at https://docs.unity3d.com/Manual/upm-concepts.html#Sources.

2 changes: 1 addition & 1 deletion Runtime/BehaviorTree.NET.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<PropertyGroup>
<PackageId>BehaviorTree.NET</PackageId>
<Version>0.1.1</Version>
<Version>0.2.0</Version>
<Authors>asasine</Authors>
<Company>asasine</Company>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
Expand Down
20 changes: 8 additions & 12 deletions docs/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,16 @@
1. [Create a new release](https://github.com/asasine/BehaviorTree.NET/releases/new)
- Tag version: `vMAJOR.MINOR.PATCH` targeting `main` (whatever version was decided above, with `v` prefix)
- Title: `vMAJOR.MINOR.PATCH`
- Description:
- Should have a single H1: `vMAJOR.MINOR.PATCH (YYYY-MM-DD)`
- Can have a small paragraph after the H1 (e.g., a summary, link to a blog post)
- Should have various H2 (omit an H2 if it would be empty):
- Description: use the `Auto-generate release notes` button.
- Add a single H1: `vMAJOR.MINOR.PATCH (YYYY-MM-DD)`
- Can have a small paragraph after the H1 (e.g., a summary, link to a blog post, etc.)
- Can have categorized H2 (omit an H2 if it would be empty), or a general `What's Changed` H2. Examples of categories:
- New Features
- Bug Fixes
- Internal
- Use an unordered list under each H2
- Each list item should have the format `#PR/#Issue Past tense description (@user)`
- `#PR/#Issue` uses the PR or Issue number from the change.
- `Past tense description` should begin with one of:
- Added
- Changed
- Fixed
- Removed
- `@user` is the GitHub username of the person who made the change.
- Each list item should have the format `{PR or Issue title} by @{user} {link}`
- `{PR or Issue title}` is the title from the PR or Issue that was merged or closed.
- `{user}` is the GitHub username of the person who made the change.
- `{link}` is the URL of the PR or Issue.
- Check `This is a pre-release` if `version < 1.0.0` or there's a pre-release suffix on the version (e.g., `0.1.1` or `1.4.2-alpha`)
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "com.asasine.behaviortree",
"version": "0.1.1",
"version": "0.2.0",
"displayName": "BehaviorTree.NET",
"description": "Behavior Trees for .NET and Unity",
"keywords": [
Expand Down

0 comments on commit fda4239

Please sign in to comment.