Back to Nx

Release Changelog Config Changes

packages/nx/src/migrations/update-21-0-0/release-changelog-config-changes.md

22.7.11.1 KB
Original Source

Nx Release Changelog Config Changes

In Nx v21, the mapAuthorsToGitHubUsernames changelog "renderOption" for the default changelog renderer was renamed to applyUsernameToAuthors to reflect the fact that it is no longer specific to GitHub. Most people were not setting this option directly, but if you were, it will be automatically migrated by this migration.

The migration will also update release groups changelog configuration, if applicable.

Sample Code Changes

Before
json
{
  "release": {
    "changelog": {
      "workspaceChangelog": {
        "renderOptions": {
          "mapAuthorsToGitHubUsernames": true
        }
      },
      "projectChangelogs": {
        "renderOptions": {
          "mapAuthorsToGitHubUsernames": false
        }
      }
    }
  }
}
After
json
{
  "release": {
    "changelog": {
      "workspaceChangelog": {
        "renderOptions": {
          "applyUsernameToAuthors": true
        }
      },
      "projectChangelogs": {
        "renderOptions": {
          "applyUsernameToAuthors": false
        }
      }
    }
  }
}