Merge branch 'main' into repo-sync

content/repositories/releasing-projects-on-github/automatically-generated-release-notes.md

@@ -50,20 +50,30 @@ Automatically generated release notes provide an automated alternative to manual
    ![Publish release and Draft release buttons](/assets/images/help/releases/release_buttons.png)
 
 
-## Creating a template for automatically generated release notes
+## Configuring automatically generated release notes
 
 {% data reusables.repositories.navigate-to-repo %}
 {% data reusables.files.add-file %}
 3. In the file name field, type `.github/release.yml` to create the `release.yml` file in the `.github` directory.
   ![Create new file](/assets/images/help/releases/release-yml.png)
-4. In the file, specify the pull request labels and authors you want to exclude from this release. You can also create new categories and list the pull request labels to be included in each of them. For more information, see "[Managing labels](/issues/using-labels-and-milestones-to-track-work/managing-labels)."
+4. In the file, using the configuration options below, specify in YAML the pull request labels and authors you want to exclude from this release. You can also create new categories and list the pull request labels to be included in each of them.
 
-## Example configuration
+### Configuration options
+
+| Parameter | Description |
+| :- | :- |
+| `changelog.exclude.labels` | A list of labels that exclude a pull request from appearing in release notes. |
+| `changelog.exclude.authors` | A list of user or bot login handles whose pull requests are to be excluded from release notes. |
+| `changelog.categories[*].title` | **Required.** The title of a category of changes in release notes. |
+| `changelog.categories[*].labels`| **Required.** Labels that qualify a pull request for this category. Use `*` as a catch-all for pull requests that didn't match any of the previous categories. |
+| `changelog.categories[*].exclude.labels` | A list of labels that exclude a pull request from appearing in this category. |
+| `changelog.categories[*].exclude.authors` | A list of user or bot login handles whose pull requests are to be excluded from this category. |
+
+### Example configuration
 
 {% raw %}
-**release.yml**
 ```yaml{:copy}
-# release.yml
+# .github/release.yml
 
 changelog:
   exclude:
@@ -86,14 +96,6 @@ changelog:
 ```
 {% endraw %}
 
-## Release template syntax
+## Further reading
 
-| Parameter | Description |Required | Value |
-| :- | :- | :- | :- |
-|`changelog` | Defines the contents within it as the custom template for your release notes.|Required. | No value accepted.|
-|`exclude`| Creates a category of pull requests to be excluded from the release. Can be set at the top-level of the changelog to apply to all categories or applied on a per-category basis. |Optional | No value accepted.|
-|`authors`| Specifies authors to be excluded from the release.| Optional for `exclude` category.| Accepts usernames and bots as values.|
-|`categories`| Defines the nested contents as custom categories to be included in the template. |Optional | No value accepted.|
-|`title`|  Creates an individual category. |Required if `categories` parameter exists.| Takes the category name as its value. |
-|`labels`|  Specifies labels to be used by the enclosing category.| Required if `categories` parameter exists, optional for `exclude` parameter.| Accepts any labels, whether currently existing or planned for the future.|
-|`"*"`| Catchall for any pull request not included within a category *above*. If used, it must be added at the end of the file. | Optional| No value accepted. |
+- "[Managing labels](/issues/using-labels-and-milestones-to-track-work/managing-labels)" 

package-lock.json

@@ -80,7 +80,7 @@
         "remark-gfm": "^3.0.1",
         "remark-parse": "^10.0.0",
         "remark-parse-no-trim": "^8.0.4",
-        "remark-rehype": "^10.0.0",
+        "remark-rehype": "^10.0.1",
         "revalidator": "^0.3.1",
         "rss-parser": "^3.12.0",
         "scroll-anchoring": "^0.1.0",
@@ -18642,9 +18642,9 @@
       }
     },
     "node_modules/remark-rehype": {
-      "version": "10.0.0",
-      "resolved": "https://registry.npmjs.org/remark-rehype/-/remark-rehype-10.0.0.tgz",
-      "integrity": "sha512-WgvJFpfRLfnyHGvQaMgLXVfaXIXVA9FFo7tSky0omLLukZvDJdobZ2V/wYGd2xlScPVZNx6/99fb5kLFT2uFWQ==",
+      "version": "10.0.1",
+      "resolved": "https://registry.npmjs.org/remark-rehype/-/remark-rehype-10.0.1.tgz",
+      "integrity": "sha512-9itJLLOrbjrAi0qO5Rh0Wzi1d3eqvRvDWSsfif6W/BInVgCvzqSnB7BSfQRtb6MLfQiufXYG3NbbUqfE0p7nTA==",
       "dependencies": {
         "@types/hast": "^2.0.0",
         "@types/mdast": "^3.0.0",
@@ -37232,9 +37232,9 @@
       }
     },
     "remark-rehype": {
-      "version": "10.0.0",
-      "resolved": "https://registry.npmjs.org/remark-rehype/-/remark-rehype-10.0.0.tgz",
-      "integrity": "sha512-WgvJFpfRLfnyHGvQaMgLXVfaXIXVA9FFo7tSky0omLLukZvDJdobZ2V/wYGd2xlScPVZNx6/99fb5kLFT2uFWQ==",
+      "version": "10.0.1",
+      "resolved": "https://registry.npmjs.org/remark-rehype/-/remark-rehype-10.0.1.tgz",
+      "integrity": "sha512-9itJLLOrbjrAi0qO5Rh0Wzi1d3eqvRvDWSsfif6W/BInVgCvzqSnB7BSfQRtb6MLfQiufXYG3NbbUqfE0p7nTA==",
       "requires": {
         "@types/hast": "^2.0.0",
         "@types/mdast": "^3.0.0",

package.json

@@ -82,7 +82,7 @@
     "remark-gfm": "^3.0.1",
     "remark-parse": "^10.0.0",
     "remark-parse-no-trim": "^8.0.4",
-    "remark-rehype": "^10.0.0",
+    "remark-rehype": "^10.0.1",
     "revalidator": "^0.3.1",
     "rss-parser": "^3.12.0",
     "scroll-anchoring": "^0.1.0",