Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 1.47 KB

MAINTAINERS.md

File metadata and controls

41 lines (26 loc) · 1.47 KB
Raw

Maintainer guide

This is a small guide dedicated to project maintainers.

Prerequisites

You need to generate a Github token with the repo permissions, following this guide. Then add this line to your shell profile: export GITHUB_TOKEN="«your-40-digit-github-token»".

Releasing a new version

Before releasing a new version, you should check for dependencies updates with npm outdated, and update them if needed. Don't forget to run npm run lint after update in case xo was updated.

Then follow these steps:

  1. Update your local main branch

  2. Make sure you have no pending changes

  3. Generate projects on all 3 UI branches (Bootstrap, Ionic and Material) and perform a visual sanity check (would love to automate this!)

  4. Run this command:

curl -H "Accept: application/vnd.github.everest-preview+json" \
  -H "Authorization: token ${GITHUB_TOKEN}" \
  -d '{ "event_type": "release" }' \
  https://api.github.com/repos/ngx-rocket/generator-ngx-rocket/dispatches

  1. Check that the release workflow has succeeded on GitHub Actions pane.

  2. Done! 🍹 Now you can tell the world a new version is out! 🔈

Website notes

HTTPS setup

HTTPS for the website is enabled through CloudFlare. Make sure that HTTPS redirection is enabled in the CloudFlare settings.