https://github.com/micro-os-plus/micro-os-plus-iii-cortexm
A source code library with µOS++ Cortex-M port
https://github.com/micro-os-plus/micro-os-plus-iii-cortexm
Last synced: 18 days ago
JSON representation
A source code library with µOS++ Cortex-M port
- Host: GitHub
- URL: https://github.com/micro-os-plus/micro-os-plus-iii-cortexm
- Owner: micro-os-plus
- License: mit
- Created: 2020-11-19T21:40:41.000Z (over 5 years ago)
- Default Branch: xpack
- Last Pushed: 2025-09-24T16:22:21.000Z (10 months ago)
- Last Synced: 2025-10-25T16:41:13.734Z (9 months ago)
- Language: C++
- Homepage:
- Size: 229 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README-MAINTAINER.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/micro-os-plus/micro-os-plus-iii-cortexm/issues/)
[](https://github.com/micro-os-plus/micro-os-plus-iii-cortexm/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):
```sh
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-development` branch:
```sh
rm -rf ~/Work/micro-os-plus/micro-os-plus-iii-cortexm.git && \
mkdir -p ~/Work/xpack-3rd-party && \
git clone \
--branch xpack-development \
https://github.com/micro-os-plus/micro-os-plus-iii-cortexm.git \
~/Work/micro-os-plus/micro-os-plus-iii-cortexm.git
```
## Prerequisites
A recent [xpm](https://xpack.github.io/xpm/), which is a portable
[Node.js](https://nodejs.org/) 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-cortexm` Git repo:
- switch to the `xpack-development` 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 the`package.json` file; add an extra field in the
pre-release field, and initially also add `.pre`,
for example `1.1.0-pre`.
### Fix possible open issues
Check GitHub issues and pull requests:
-
and fix them; assign them to a milestone (like `1.1.0`).
### Update `README-MAINTAINER.md`
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.1.0_
- commit with a message like _prepare v1.1.0_
### Push changes
- commit and push
### Commit the new version
- select the `xpack-development` 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.1.0`
- push the `xpack-development` 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-development` into `xpack`
- push to GitHub
- select `xpack-development`