> For the complete documentation index, see [llms.txt](https://cortex-docs.paloaltonetworks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cortex-docs.paloaltonetworks.com/demisto-sdk-development-guide/demisto-sdk-guide/demisto-sdk-commands/update-release-notes.md).

# update-release-notes

Automatically generates release notes for a given pack and updates the **`pack_metadata.json`** version for changed items.

This command creates a new release notes file under the **`ReleaseNotes`** directory in the given pack in the form of **`X_Y_Z.md`** where **`X_Y_Z`** is the new pack version. The command automatically bumps the `currentVersion` found in the `pack_metadata.json` file. After running this command, add the newly created release notes file to GitHub and add notes under their respective headlines.

For a private repository and an unconfigured `DEMISTO_SDK_GITHUB_TOKEN`, remote files are fetched from the remote branch of the local repository.

<details>

<summary>Arguments</summary>

| Argument                          | Description                                                                                                                                                                                                                                                                                                 |
| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `-i, --input <PACK_PATH>`         | The path of the content pack to generate release notes for.                                                                                                                                                                                                                                                 |
| `-u, --update-type`               | <p>Optional. If no <code>update\_type</code> is defined, the <code>currentVersion</code> is bumped as a revision. Refers to the type of update. Options are:</p><ul><li><code>major</code></li><li><code>minor</code></li><li><code>revision</code></li><li><code>documentation</code> (revision)</li></ul> |
| `-g, --use-git`                   | Uses Git to identify the relevant changed files and updates all release notes in every pack that has changes. Used by default if `-i` is not set. The `-u` argument is applied to all changed packs.                                                                                                        |
| `-f, --force`                     | Updates the release notes of a pack even if no changes requiring an update were made.                                                                                                                                                                                                                       |
| `--text`                          | Text to add to all release notes files.                                                                                                                                                                                                                                                                     |
| `--pre_release`                   | Indicates that this update is for a pre-release version. The `currentVersion` changes to reflect the pre-release version number.                                                                                                                                                                            |
| `--prev-ver`                      | Previous branch or SHA1 commit to run checks against.                                                                                                                                                                                                                                                       |
| `-v, --version <DESIRED_VERSION>` | Bumps to a specific version. Cannot be used with `-u, --update-type` flags.                                                                                                                                                                                                                                 |
| `-bc, --breaking-changes`         | Whether a new version contains breaking changes.                                                                                                                                                                                                                                                            |

</details>

<details>

<summary>Examples</summary>

* `demisto-sdk update-release-notes -i Packs/HelloWorld -u minor`

  Creates a new Markdown file in the `ReleaseNotes` folder for the HelloWorld pack and bumps the `currentVersion` with a minor increment.
* `demisto-sdk update-release-notes -i Packs/HelloWorld -u major`

  Creates a new Markdown file in the `ReleaseNotes` folder for the HelloWorld pack and bumps the `currentVersion` with a major increment.
* `demisto-sdk update-release-notes -i Packs/HelloWorld -u revision`

  Creates a new Markdown file in the `ReleaseNotes` folder for the HelloWorld pack and bumps the `currentVersion` with a revision increment.
* `demisto-sdk update-release-notes -g -u revision`

  Creates a new Markdown file in the `ReleaseNotes` folder for all changed packs and bumps the `currentVersion` with a revision increment.
* `demisto-sdk update-release-notes -i Packs/HelloWorld -u revision --pre_release`

  Creates a new Markdown file in the `ReleaseNotes` folder for the HelloWorld pack and bumps the `currentVersion` with a revision increment, appending `pre_release` to the `currentVersion`.

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://cortex-docs.paloaltonetworks.com/demisto-sdk-development-guide/demisto-sdk-guide/demisto-sdk-commands/update-release-notes.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.