Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/micro-os-plus/diag-trace-xpack
A source xPack with the µOS++ tracing infrastructure
https://github.com/micro-os-plus/diag-trace-xpack
Last synced: about 1 month ago
JSON representation
A source xPack with the µOS++ tracing infrastructure
- Host: GitHub
- URL: https://github.com/micro-os-plus/diag-trace-xpack
- Owner: micro-os-plus
- License: mit
- Created: 2017-09-04T15:25:43.000Z (over 7 years ago)
- Default Branch: xpack
- Last Pushed: 2023-11-28T21:10:11.000Z (about 1 year ago)
- Last Synced: 2024-11-30T22:07:53.379Z (about 1 month ago)
- Language: C++
- Homepage:
- Size: 396 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README-MAINTAINER.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/micro-os-plus/diag-trace-xpack/blob/xpack/LICENSE)
[](https://github.com/micro-os-plus/diag-trace-xpack/actions/workflows/ci.yml)
[](https://github.com/micro-os-plus/diag-trace-xpack/issues/)
[](https://github.com/micro-os-plus/diag-trace-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/micro-os-plus/diag-trace-xpack.git && \
mkdir -p ~/Work/micro-os-plus && \
git clone \
https://github.com/micro-os-plus/diag-trace-xpack.git \
~/Work/micro-os-plus/diag-trace-xpack.git
```
For development purposes, clone the `xpack-develop` branch:
```sh
rm -rf ~/Work/micro-os-plus/diag-trace-xpack.git && \
mkdir -p ~/Work/micro-os-plus && \
git clone \
--branch xpack-develop \
https://github.com/micro-os-plus/diag-trace-xpack.git \
~/Work/micro-os-plus/diag-trace-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.
Always reformat the source files that were changed.
## How to make new releases
### Release schedule
There are no fixed releases.
### Check Git
In the `micro-os-plus/diag-trace-xpack` 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
Determine the upstream version (like `4.2.1`) and eventually update the
`package.json` file; the format is `4.2.1-pre`.
### Fix possible open issues
Check GitHub issues and pull requests:
-
and fix them; assign them to a milestone (like `4.2.1`).
### Update `README-MAINTAINER.md`
Update the `README-MAINTAINER.md` file to reflect the changes
related to the new version.
### Update `CHANGELOG.md`
- open the `CHANGELOG.md` file
- check if all previous fixed issues are in
- add a new entry like _* v4.2.1_
- commit with a message like _prepare v4.2.1_
### Push changes
- reformat the source files that were changed
- commit and push
## Manual tests
It is also possible to run the tests manually:
```sh
xpm run install-all -C ~/Work/micro-os-plus/diag-trace-xpack.git
xpm run test-all -C ~/Work/micro-os-plus/diag-trace-xpack.git
```
## Publish on the npmjs.com server
- 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 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
()
### Test on all platforms
In addition, it is possible to manually trigger a **test-all** job, that
runs all available builds, on all supported platforms, including Linux Arm
and macOS Apple Silicon.
For this:
- start the `~/actions-runners/micro-os-plus/run.sh &` runner on `xbbma` and `xbbla`
- ensure that the `xpack-develop` branch is pushed
- run the `trigger-workflow-test-all` action
- wait for the **test-all** job to complete
()
### Publish
- `npm publish --tag next` (use `npm publish --access public` when
publishing for the first time)
The version is visible at:
-
## 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/diag-trace`
- `npm dist-tag add @micro-os-plus/[email protected] latest`
- `npm dist-tag ls @micro-os-plus/diag-trace`