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-cortexm.git && \
mkdir -p ~/Work/xpack-3rd-party && \
git clone \
https://github.com/micro-os-plus/micro-os-plus-iii-cortexm.git \
~/Work/micro-os-plus/micro-os-plus-iii-cortexm.git
For development purposes, clone the xpack-develop
branch:
rm -rf ~/Work/micro-os-plus/micro-os-plus-iii-cortexm.git && \
mkdir -p ~/Work/xpack-3rd-party && \
git clone \
--branch xpack-develop \
https://github.com/micro-os-plus/micro-os-plus-iii-cortexm.git \
~/Work/micro-os-plus/micro-os-plus-iii-cortexm.git
A recent xpm, which is a portable Node.js command line application.
There are no fixed releases, the project aims to follow the upstream releases.
In the micro-os-plus/micro-os-plus-iii-cortexm
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.
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
.
Check GitHub issues and pull requests:
and fix them; assign them to a milestone (like 1.0.0
).
Update the following files to reflect the changes related to the new version:
README-MAINTAINER.md
README.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
- commit and push
- select the
xpack-develop
branch - commit all changes
npm pack
and check the content of the archive, which should list onlypackage.json
,README.md
,LICENSE
,CHANGELOG.md
, thedoxygen-awesome-*.js
anddoxygen-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 viagit push origin --tags
When the package is considered stable:
- with a Git client (VS Code is fine)
- merge
xpack-develop
intoxpack
- push to GitHub
- select
xpack-develop