{"id":22377094,"url":"https://github.com/micro-os-plus/diag-trace-xpack","last_synced_at":"2026-03-04T01:15:34.632Z","repository":{"id":44814887,"uuid":"102375627","full_name":"micro-os-plus/diag-trace-xpack","owner":"micro-os-plus","description":"A source xPack with the µOS++ tracing infrastructure","archived":false,"fork":false,"pushed_at":"2023-11-28T21:10:11.000Z","size":405,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"xpack","last_synced_at":"2025-03-18T18:49:50.371Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/micro-os-plus.png","metadata":{"files":{"readme":"README-MAINTAINER.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":"ilegeul","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2017-09-04T15:25:43.000Z","updated_at":"2022-02-05T14:52:43.000Z","dependencies_parsed_at":"2023-11-28T22:26:05.993Z","dependency_job_id":"131ca687-5815-42a8-b7bf-8de3aab50e8c","html_url":"https://github.com/micro-os-plus/diag-trace-xpack","commit_stats":null,"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micro-os-plus%2Fdiag-trace-xpack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micro-os-plus%2Fdiag-trace-xpack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micro-os-plus%2Fdiag-trace-xpack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micro-os-plus%2Fdiag-trace-xpack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/micro-os-plus","download_url":"https://codeload.github.com/micro-os-plus/diag-trace-xpack/tar.gz/refs/heads/xpack","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245708992,"owners_count":20659626,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-04T22:12:46.097Z","updated_at":"2026-03-04T01:15:34.610Z","avatar_url":"https://github.com/micro-os-plus.png","language":"C++","funding_links":["https://ko-fi.com/ilegeul"],"categories":[],"sub_categories":[],"readme":"[![license](https://img.shields.io/github/license/micro-os-plus/diag-trace-xpack)](https://github.com/micro-os-plus/diag-trace-xpack/blob/xpack/LICENSE)\n[![CI on Push](https://github.com/micro-os-plus/diag-trace-xpack/actions/workflows/ci.yml/badge.svg)](https://github.com/micro-os-plus/diag-trace-xpack/actions/workflows/ci.yml)\n[![GitHub issues](https://img.shields.io/github/issues/micro-os-plus/diag-trace-xpack.svg)](https://github.com/micro-os-plus/diag-trace-xpack/issues/)\n[![GitHub pulls](https://img.shields.io/github/issues-pr/micro-os-plus/diag-trace-xpack.svg)](https://github.com/micro-os-plus/diag-trace-xpack/pulls)\n\n# Maintainer info\n\n## Project repository\n\nThe project is hosted on GitHub:\n\n- \u003chttps://github.com/micro-os-plus/diag-trace-xpack.git\u003e\n\nTo clone the stable branch (`xpack`), run the following commands in a\nterminal (on Windows use the _Git Bash_ console):\n\n```sh\nrm -rf ~/Work/micro-os-plus/diag-trace-xpack.git \u0026\u0026 \\\nmkdir -p ~/Work/micro-os-plus \u0026\u0026 \\\ngit clone \\\n  https://github.com/micro-os-plus/diag-trace-xpack.git \\\n  ~/Work/micro-os-plus/diag-trace-xpack.git\n```\n\nFor development purposes, clone the development branch (`xpack-development`):\n\n```sh\nrm -rf ~/Work/micro-os-plus/diag-trace-xpack.git \u0026\u0026 \\\nmkdir -p ~/Work/micro-os-plus \u0026\u0026 \\\ngit clone \\\n  --branch xpack-development \\\n  https://github.com/micro-os-plus/diag-trace-xpack.git \\\n  ~/Work/micro-os-plus/diag-trace-xpack.git\n```\n\nTo link it to the central xPack store:\n\n```sh\nxpm link -C ~/Work/micro-os-plus/diag-trace-xpack.git\n```\n\n## Prerequisites\n\nA recent [xpm](https://xpack.github.io/xpm/), which is a portable\n[Node.js](https://nodejs.org/) command line application.\n\nTo run the native tests, a C++ development environment is required.\nOn macOS install Command Line Tools, on Ubuntu `build-essential`.\n\n## Code formatting\n\nCode formatting is done using `clang-format --style=file`, either manually\nfrom a script, or automatically from Visual Studio Code, or the Eclipse\nCppStyle plug-in.\n\nAlways reformat the source files that were changed.\n\n## How to make new releases\n\n### Release schedule\n\nThere are no fixed releases.\n\n### Check Git\n\nIn the `micro-os-plus/diag-trace-xpack` Git repo:\n\n- switch to the `xpack-development` branch\n- if needed, merge the `xpack` branch\n\nNo need to add a tag here, it'll be added when the release is created.\n\n### Increase the version\n\nDetermine the upstream version (like `4.2.2`) and eventually update the\n`package.json` file; the format is `4.2.2-pre`.\n\n### Fix possible open issues\n\nCheck GitHub issues and pull requests:\n\n- \u003chttps://github.com/micro-os-plus/diag-trace-xpack/issues/\u003e\n\nand fix them; assign them to a milestone (like `4.2.2`).\n\n### Update `README-MAINTAINER.md`\n\nUpdate the `README-MAINTAINER.md` file to reflect the changes\nrelated to the new version.\n\n### Update `CHANGELOG.md`\n\n- open the `CHANGELOG.md` file\n- check if all previous fixed issues are in\n- add a new entry like _* v4.2.2_\n- commit with a message like _prepare v4.2.2_\n\n### Push changes\n\n- reformat the source files that were changed\n- commit and push\n\n## Manual tests\n\nIt is also possible to run the tests manually:\n\n```sh\nxpm run install-all -C ~/Work/micro-os-plus/diag-trace-xpack.git\nxpm run test-all -C ~/Work/micro-os-plus/diag-trace-xpack.git\n```\n\n## Publish on the npmjs.com server\n\n- select the `xpack-development` branch\n- commit all changes\n- `npm pack` and check the content of the archive, which should list\n  only `package.json`, `README.md`, `LICENSE`, `CHANGELOG.md`,\n  the sources and CMake/meson files;\n  possibly adjust `.npmignore`\n- `npm version patch`, `npm version minor`, `npm version major`\n- push the `xpack-development` branch to GitHub\n- the `postversion` npm script should also update tags via `git push origin --tags`\n- wait for the CI job to complete\n  (\u003chttps://github.com/micro-os-plus/diag-trace-xpack/actions/workflows/test-ci.yml\u003e)\n\n### Test on all platforms\n\nIn addition, it is possible to manually trigger a **test-all** job, that\nruns all available builds, on all supported platforms, including Linux Arm\nand macOS Apple Silicon.\n\nFor this:\n\n- start the `~/actions-runners/micro-os-plus/run.sh \u0026` runner on `xbbma` and `xbbla`\n- ensure that the `xpack-development` branch is pushed\n- run the `trigger-workflow-test-all` action\n- wait for the **test-all** job to complete\n  (\u003chttps://github.com/micro-os-plus/diag-trace-xpack/actions/workflows/test-all.yml\u003e)\n\n### Publish\n\n- `npm publish --tag next` (use `npm publish --access public` when\n  publishing for the first time)\n\nThe version is visible at:\n\n- \u003chttps://www.npmjs.com/package/@micro-os-plus/diag-trace?activeTab=versions\u003e\n\n## Update the repo\n\nWhen the package is considered stable:\n\n- with a Git client (VS Code is fine)\n- merge `xpack-development` into `xpack`\n- push to GitHub\n- select `xpack-development`\n\n## Tag the npm package as `latest`\n\nWhen the release is considered stable, promote it as `latest`:\n\n- `npm dist-tag ls @micro-os-plus/diag-trace`\n- `npm dist-tag add @micro-os-plus/diag-trace@4.2.2 latest`\n- `npm dist-tag ls @micro-os-plus/diag-trace`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicro-os-plus%2Fdiag-trace-xpack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicro-os-plus%2Fdiag-trace-xpack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicro-os-plus%2Fdiag-trace-xpack/lists"}