|
| 1 | +changelog: |
| 2 | + # Body format of changelog. |
| 3 | + # Available values: |
| 4 | + # context: Context object passed into action as 'context' parameter. |
| 5 | + # releases: Array of release objects. (Read about release object: https://docs.github.com/en/rest/reference/repos#list-releases.) |
| 6 | + # releasesFormatted: Formatted releases as text. |
| 7 | + body: | |
| 8 | + # Changelog |
| 9 | +
|
| 10 | + All notable changes to this project will be documented in this file. |
| 11 | +
|
| 12 | + The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), |
| 13 | + and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
| 14 | +
|
| 15 | + {releasesFormatted} |
| 16 | + |
| 17 | + # Release format. |
| 18 | + # Available values: |
| 19 | + # context: Context object passed into action as 'context' parameter. |
| 20 | + # releases: Array of release objects. (Same as 'releases' in body.) |
| 21 | + # release: Release object. (Read about release object: https://docs.github.com/en/rest/reference/repos#get-a-release.) |
| 22 | + # date: Date object created based on 'dateFormat' settings. |
| 23 | + release: | |
| 24 | + ## [{release.tag_name}]({release.html_url}) - {date.year}-{date.month}-{date.day} |
| 25 | +
|
| 26 | + # Determines whether to include release body after 'release' format. |
| 27 | + releaseBody: true |
| 28 | + |
| 29 | + # Used instead of release body format when is empty. |
| 30 | + empty: | |
| 31 | + - No release notes. |
| 32 | +
|
| 33 | + # Settings used to format publish date of release. |
| 34 | + # (Read about possible options: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat.) |
| 35 | + dateFormat: |
| 36 | + locale: en |
| 37 | + day: 2-digit |
| 38 | + month: 2-digit |
| 39 | + year: numeric |
| 40 | + |
| 41 | +readme: |
| 42 | + # Readme format of package. |
| 43 | + # Available values: |
| 44 | + # context: Context object passed into action as 'context' parameter. |
| 45 | + # package: Package object. |
| 46 | + # dependenciesFormatted: Formatted dependencies as text. |
| 47 | + body: | |
| 48 | + # {package.name} |
| 49 | +
|
| 50 | + {package.displayName} |
| 51 | +
|
| 52 | + ## Information |
| 53 | + |
| 54 | + - **Version**: `{package.version}` |
| 55 | + - **Unity**: `{package.unity}` |
| 56 | + - **API Compatibility Level**: `{package.apiCompatibility}` |
| 57 | +
|
| 58 | + ### Dependencies |
| 59 | +
|
| 60 | + {dependenciesFormatted} |
| 61 | +
|
| 62 | + ### Description |
| 63 | +
|
| 64 | + {package.description} |
| 65 | +
|
| 66 | + ### Changelog |
| 67 | +
|
| 68 | + - [Full changelog](changelog.md) |
| 69 | +
|
| 70 | + ### Registry |
| 71 | +
|
| 72 | + Read about where packages stored: [Registry](https://github.com/unity-game-framework/organization/blob/main/docs/registry.md). |
| 73 | +
|
| 74 | + ## How to Install |
| 75 | +
|
| 76 | + Read about how to install any packages from the `Unity Game Framework` registry: [Install Package](https://github.com/unity-game-framework/organization/blob/main/docs/install-packages.md). |
| 77 | +
|
| 78 | + # Dependency format of package dependencies. |
| 79 | + # Available values: |
| 80 | + # context: Context object passed into action as 'context' parameter. |
| 81 | + # package: Package object. |
| 82 | + # dependency: Dependency object. |
| 83 | + # name: Name of dependency. |
| 84 | + # version: Version of dependency. |
| 85 | + dependency: | |
| 86 | + - `{dependency.name}`: `{dependency.version}` |
| 87 | +
|
| 88 | + # Used instead of 'dependency' format when no any dependencies found. |
| 89 | + dependenciesEmpty: | |
| 90 | + - N/A |
| 91 | +
|
| 92 | +notes: |
| 93 | + # Body format of release changelog. |
| 94 | + # Available values: |
| 95 | + # context: Context object passed into action as 'context' parameter. |
| 96 | + # milestone: Milestone object. (Read about milestone object: https://docs.github.com/en/rest/reference/issues#get-a-milestone.) |
| 97 | + # groups: Array of the group objects. (Read about group object below.) |
| 98 | + # groupsFormatted: Formatted groups as text. |
| 99 | + # Description of group object. |
| 100 | + # group: |
| 101 | + # name: Name of group from config. |
| 102 | + # issues: Array of issue objects. (Read about issue object: https://docs.github.com/en/rest/reference/issues#get-an-issue.) |
| 103 | + body: | |
| 104 | + ### Release Notes |
| 105 | +
|
| 106 | + - [Milestone]({milestone.html_url}?closed=1) |
| 107 | + {milestone.description} |
| 108 | + |
| 109 | + {groupsFormatted} |
| 110 | +
|
| 111 | + # Used instead of 'body' format when no any issues found for milestone. |
| 112 | + empty: | |
| 113 | + ### Release Notes |
| 114 | +
|
| 115 | + - No release notes. |
| 116 | +
|
| 117 | + # Group format of issues. |
| 118 | + # Available values: |
| 119 | + # context: Context object passed into action as 'context' parameter. |
| 120 | + # milestone: Milestone object. (Same as milestone in body.) |
| 121 | + # groups: Array of the group objects. (Same as groups in body.) |
| 122 | + # group: Group object. (Read about group in body description.) |
| 123 | + # issuesFormatted: Formatted issues as text. |
| 124 | + group: | |
| 125 | + ### {group.name} |
| 126 | + |
| 127 | + {issuesFormatted} |
| 128 | +
|
| 129 | + # Issue format from group. |
| 130 | + # Available values: |
| 131 | + # context: Context object passed into action as 'context' parameter. |
| 132 | + # milestone: Milestone object. (Same as 'milestone' in body.) |
| 133 | + # groups: Array of the group objects. (Same as 'groups' in body.) |
| 134 | + # group: Group object. (Read about 'group' in body description.) |
| 135 | + # issue: Issue object. (Read about issue object: https://docs.github.com/en/rest/reference/issues#get-an-issue.) |
| 136 | + issue: | |
| 137 | + - {issue.title} ([#{issue.number}]({issue.html_url})) |
| 138 | +
|
| 139 | + # Determines whether to include indented issue body after 'issue' format. |
| 140 | + issueBody: true |
| 141 | + |
| 142 | + # Setting to group issues before formatting. |
| 143 | + # Every group has some properties. |
| 144 | + # group: |
| 145 | + # name: Name of group. |
| 146 | + # state: State of issue to find in milestone. (Possible values: 'open', 'closed' or 'all', more about issues: https://docs.github.com/en/rest/reference/issues.) |
| 147 | + # labels: List of comma separated label names used to determine whether to include issue in group. (Example: 'bug,fix'.) |
| 148 | + groups: |
| 149 | + - name: Added |
| 150 | + state: all |
| 151 | + labels: Feature |
| 152 | + - name: Changed |
| 153 | + state: all |
| 154 | + labels: Change |
| 155 | + - name: Deprecated |
| 156 | + state: all |
| 157 | + labels: Deprecation |
| 158 | + - name: Removed |
| 159 | + state: all |
| 160 | + labels: Remove |
| 161 | + - name: Fixed |
| 162 | + state: all |
| 163 | + labels: Fix |
| 164 | + - name: Security |
| 165 | + state: all |
| 166 | + labels: Security |
| 167 | + |
| 168 | +# List of labels to add or update. |
| 169 | +# Each element has some properties. (Read about labels: https://docs.github.com/en/rest/reference/issues#update-a-label) |
| 170 | +# name: The name of the label. |
| 171 | +# description: A short description of the label. |
| 172 | +# color: The hexadecimal color code for the label, without the leading #. |
| 173 | +labels: |
| 174 | +- name: Archived |
| 175 | + description: An issue no longer relevant, but can be reopened. |
| 176 | + color: fef2c0 |
| 177 | +- name: Bug |
| 178 | + description: An issue describes an unexpected problem or unintended behavior. |
| 179 | + color: f9d0c4 |
| 180 | +- name: Change |
| 181 | + description: Mentioned in changelog under the Changed section. |
| 182 | + color: c5def5 |
| 183 | +- name: Deprecation |
| 184 | + description: Mentioned in changelog under the Deprecated section. |
| 185 | + color: c5def5 |
| 186 | +- name: Feature |
| 187 | + description: Mentioned in changelog under the Added section. |
| 188 | + color: c2e0c6 |
| 189 | +- name: Fix |
| 190 | + description: Mentioned in changelog under the Fixed section. |
| 191 | + color: c5def5 |
| 192 | +- name: Remove |
| 193 | + description: Mentioned in changelog under the Removed section. |
| 194 | + color: f9d0c4 |
| 195 | +- name: Security |
| 196 | + description: Mentioned in changelog under the Security section. |
| 197 | + color: c5def5 |
0 commit comments