Skip to content

Latest commit

 

History

History
106 lines (71 loc) · 3.01 KB

README-MAINTAINER.md

File metadata and controls

106 lines (71 loc) · 3.01 KB
Raw

GitHub issues GitHub pulls

Maintainer info

Project repository

The project is hosted on GitHub:

To clone the stable branch (xpack), run the following commands in a terminal (on Windows use the Git Bash console):

rm -rf ~/Work/micro-os-plus/micro-os-plus-iii-posix-arch.git && \
mkdir -p ~/Work/xpack-3rd-party && \
git clone \
  https://github.com/micro-os-plus/micro-os-plus-iii-posix-arch.git \
  ~/Work/micro-os-plus/micro-os-plus-iii-posix-arch.git

For development purposes, clone the xpack-develop branch:

rm -rf ~/Work/micro-os-plus/micro-os-plus-iii-posix-arch.git && \
mkdir -p ~/Work/xpack-3rd-party && \
git clone \
  --branch xpack-develop \
  https://github.com/micro-os-plus/micro-os-plus-iii-posix-arch.git \
  ~/Work/micro-os-plus/micro-os-plus-iii-posix-arch.git

Prerequisites

A recent xpm, which is a portable Node.js command line application.

How to make new releases

Release schedule

There are no fixed releases, the project aims to follow the upstream releases.

Check Git

In the micro-os-plus/micro-os-plus-iii-posix-arch Git repo:

  • switch to the xpack-develop branch
  • if needed, merge the xpack branch

No need to add a tag here, it'll be added when the release is created.

Increase the version

Update thepackage.json file; add an extra field in the pre-release field, and initially also add .pre, for example 1.0.0-pre.1.

Fix possible open issues

Check GitHub issues and pull requests:

and fix them; assign them to a milestone (like 1.0.0).

Update the `README*.md`` files

Update the following files to reflect the changes related to the new version:

  • README-MAINTAINER.md
  • README.md

Update CHANGELOG.md

  • open the CHANGELOG.md file
  • check if all previous fixed issues are in
  • add a new entry like * v1.0.0
  • commit with a message like prepare v1.0.0

Push changes

  • commit and push

Commit the new version

  • select the xpack-develop branch
  • commit all changes
  • npm pack and check the content of the archive, which should list only package.json, README.md, LICENSE, CHANGELOG.md, the doxygen-awesome-*.js and doxygen-custom/* files; possibly adjust .npmignore
  • npm version 1.0.0
  • push the xpack-develop branch to GitHub
  • the postversion npm script should also update tags via git push origin --tags

Update the repo

When the package is considered stable:

  • with a Git client (VS Code is fine)
  • merge xpack-develop into xpack
  • push to GitHub
  • select xpack-develop