# Changelog

Track your artifacts & user stories as they progress through different environments, with release changelogs

* [`sfp changelog generate`](#sfp-changelog-generate)

## `sfp changelog generate`

Generates release changelog, providing a summary of artifact versions, work items and commits introduced in a release. Creates a release definition based on artifacts contained in the artifact directory, and compares it to previous release definition in changelog stored on a source repository

```
USAGE
  $ sfp changelog generate -d <value> -n <value> -w <value> [--json] [--limit <value>] [--workitemurl <value>]
    [--directory <value>] (--nopush -b <value>) [--showallartifacts] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -b, --branchname=<value>      (required) Repository branch in which the changelog files are located
  -d, --artifactdir=<value>     (required) [default: artifacts] Directory containing sfp artifacts
  -n, --releasename=<value>     (required) Name of the release for which to generate changelog
  -w, --workitemfilter=<value>  (required) Regular expression used to search for work items (user stories) introduced in
                                release
      --directory=<value>       Relative path to directory to which the release definition file should be generated, if
                                the directory doesnt exist, it will be created
      --limit=<value>           limit the number of releases to display in changelog markdown
      --loglevel=<option>       [default: info] logging level for this command invocation
                                <options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --nopush                  Do not push the changelog to a repository to the provided branch
      --showallartifacts        Show all artifacts in changelog markdown, including those that have not changed in the
                                release
      --workitemurl=<value>     Generic URL for work items. Each work item ID will be appended to the URL, providing
                                quick access to work items

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Generates release changelog, providing a summary of artifact versions, work items and commits introduced in a release.
  Creates a release definition based on artifacts contained in the artifact directory, and compares it to previous
  release definition in changelog stored on a source repository

EXAMPLES
  $ sfp changelog:generate -n <releaseName> -d path/to/artifact/directory -w <regexp> -r <repoURL> -b <branchName>
```

*See code:* [*src/commands/changelog/generate.ts*](https://source.flxbl.io/flxbl/sfp-pro)


---

# Agent Instructions: 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:

```
GET https://docs.flxbl.io/flxbl/sfp/sfp-community/cli-reference-v50-and-below/advanced/changelog.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.