Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/micro-os-plus/devices-qemu-cortexm-xpack
A source xPack with support code for running tests on QEMU
https://github.com/micro-os-plus/devices-qemu-cortexm-xpack
Last synced: about 1 month ago
JSON representation
A source xPack with support code for running tests on QEMU
- Host: GitHub
- URL: https://github.com/micro-os-plus/devices-qemu-cortexm-xpack
- Owner: micro-os-plus
- License: mit
- Created: 2022-01-11T10:08:39.000Z (almost 3 years ago)
- Default Branch: xpack
- Last Pushed: 2023-11-28T21:09:57.000Z (about 1 year ago)
- Last Synced: 2024-03-23T22:22:17.642Z (10 months ago)
- Language: C
- Homepage:
- Size: 116 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README-MAINTAINER.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/micro-os-plus/devices-qemu-cortexm-xpack/blob/xpack/LICENSE)
[](https://github.com/micro-os-plus/devices-qemu-cortexm-xpack/actions?query=workflow%3A%22CI+on+Push%22)
[](https://github.com/micro-os-plus/devices-qemu-cortexm-xpack/issues/)
[](https://github.com/micro-os-plus/devices-qemu-cortexm-xpack/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/device-qemu-cortexm-xpack.git && \
mkdir -p ~/Work && \
git clone \
https://github.com/micro-os-plus/devices-qemu-cortexm-xpack.git \
~/Work/device-qemu-cortexm-xpack.git
```
For development purposes, clone the `xpack-develop` branch:
```sh
rm -rf ~/Work/device-qemu-cortexm-xpack.git && \
mkdir -p ~/Work && \
git clone \
--branch xpack-develop \
https://github.com/micro-os-plus/devices-qemu-cortexm-xpack.git \
~/Work/device-qemu-cortexm-xpack.git
```
## Prerequisites
A recent [xpm](https://xpack.github.io/xpm/), which is a portable
[Node.js](https://nodejs.org/) command line application.
## Code formatting
Code formatting is done using `clang-format --style=file`, either manually
from a script, or automatically from Visual Studio Code, or the Eclipse
CppStyle plug-in.
## Publish on the npmjs.com server
- select the `xpack-develop` branch
- commit all changes
- update versions in `README.md` and `README-MAINTAINER.md`
- update `CHANGELOG.md`
- commit with a message like _prepare v4.1.1_
- `npm pack` and check the content of the archive, which should list
only `package.json`, `README.md`, `LICENSE`, `CHANGELOG.md`,
the sources and CMake/meson files;
possibly adjust `.npmignore`
- `npm version patch`, `npm version minor`, `npm version major`
- push the `xpack-develop` branch to GitHub
- the `postversion` npm script should also update tags via `git push origin --tags`
- wait for the CI job to complete
()
- `npm publish --tag next` (use `npm publish --access public` when
publishing for the first time)
The version is visible at:
-
## Testing
The project includes unit tests.
To run them, run:
```sh
cd device-qemu-cortexm-xpack.git
xpm run install-all
xpm run test
```
## Continuous Integration
The CI tests are performed on GitHub Actions, as the
[CI on Push](https://github.com/micro-os-plus/devices-qemu-cortexm-xpack/actions?query=workflow%3A%22CI+on+Push%22)
workflow.
## 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`
## Tag the npm package as `latest`
When the release is considered stable, promote it as `latest`:
- `npm dist-tag ls @micro-os-plus/devices-qemu-cortexm`
- `npm dist-tag add @micro-os-plus/[email protected] latest`
- `npm dist-tag ls @micro-os-plus/devices-qemu-cortexm`
## Share on Twitter
- in a separate browser windows, open [TweetDeck](https://tweetdeck.twitter.com/)
- using the `@micro_os_plus` account
- paste the release name like **µOS++ device-qemu-cortexm v4.1.1 released**
- paste the link to the Web page release
- click the **Tweet** button