Skip to content

Latest commit

 

History

History
50 lines (40 loc) · 2.22 KB

RELEASING.md

File metadata and controls

50 lines (40 loc) · 2.22 KB
Raw

How-To Release an XDM Snapshot

The XDM project is using the GitHub release mechanism to tag and publish releases. There are a few tasks to be done to prepare the repository for the release off of the master branch.

Release Tasks.

Note: We are currently only release pre-release versions as we have not stabilized our models fully yet.

Note: The current release cadence is a monthly release cycle where the releases are cut around the middle of the month. The next planned release is indicated at the bottom of the changelog.

Steps to execute a release:

  • Clone and update the master branch of the adobe/xdm repository in your local workspace
  • Make sure there are no pending changes (git status) and all pull requests scheduled for the release are merged
  • Test the schemas and fix any issues indicated:
$ npm test
$ npm run lint
  • Define a version number to use, for example 0.9.3
  • Update the version property in package.json with the version number
  • Update the current version in the README.md file with the version number
  • Update the title in the introduction with the version number
  • Update the changelog:
    • Make sure all closed issues and merged pull requests since the last release are listed in chronological order
    • Indicate the planned release as released with the updated actual release date and link to the release tag
    • Add a new planned release with expected release version and date at the top
  • Update reference docs:
$ npm run clean
$ npm run markdown
$ git commit -m"Prepare for release $version" -a
  • Create the release following the instructions for GitHub Release creation:
    • Use the version number prefixed with (lowercase) vas the tag name, for example v0.9.3
    • Make sure the master branch is chosen as the basis for the release
    • Use the tag name from the first step for the Release title as well
    • Add a small comment to Describe the release and copy the change log for the release from changelog
    • Check the This is a pre-release box
    • Click Publish Release
  • Spread the word and party !