Skip to content

How to release a new version

Ruslan Hrabovyi edited this page Jan 20, 2024 · 13 revisions
  1. Publish

    1. Write release notes and assign github tag

    2. Increase version number (make sure you do it from the addon/ folder)

      $ cd addon && npm version minor
    3. Push code to github and push tags

      $ git push origin master --follow-tags
    4. Publish release notes in github

    5. Publish npm package

      $ npm login
      Username: your_npm_username
      Password:
      Email: (this IS public) [email protected]
      $ npm publish

      If we are publishing an alpha or beta version, we have to set the appropriate tag on publish

      $ npm publish --tag beta
      
  2. Update the documentation site

    1. Checkout the gh-pages branch and pull the latest from GitHub
    2. Checkout master
    3. Make sure you do the next steps from the docs/ folder
      $ cd docs/
    4. Generate the documentation using npm run build
    5. If you're releasing a minor or major version (but not a patch version) you have to update _data/navs.yml with the navigation for the new version at the top of the file. (This populates the sidebar nav for that version, includes the version in the version switcher dropdown, and redirects the homepage to the new version's docs.)
    6. Commit the changes to the gh-pages branch
    7. Push the gh-pages branch to GitHub, which publishes the new documentation.
  3. Send a tweet

  4. Add a comment on Ember's Discord (#addon-announcements)

  5. Add a comment to each released PR from people that are not maintainers

Clone this wiki locally