{"id":22377123,"url":"https://github.com/micro-os-plus/devices-cortexa-xpack","last_synced_at":"2025-03-26T18:18:59.551Z","repository":{"id":49615206,"uuid":"499636538","full_name":"micro-os-plus/devices-cortexa-xpack","owner":"micro-os-plus","description":"A source library xPack with µOS++ Cortex-A devices support","archived":false,"fork":false,"pushed_at":"2023-11-28T21:09:51.000Z","size":77,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"xpack","last_synced_at":"2025-03-01T14:47:41.871Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":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":"2022-06-03T20:02:24.000Z","updated_at":"2022-06-03T20:14:08.000Z","dependencies_parsed_at":"2023-11-28T22:25:54.755Z","dependency_job_id":null,"html_url":"https://github.com/micro-os-plus/devices-cortexa-xpack","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micro-os-plus%2Fdevices-cortexa-xpack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micro-os-plus%2Fdevices-cortexa-xpack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micro-os-plus%2Fdevices-cortexa-xpack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micro-os-plus%2Fdevices-cortexa-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/devices-cortexa-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:53.478Z","updated_at":"2025-03-26T18:18:59.527Z","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/devices-cortexa-xpack)](https://github.com/micro-os-plus/devices-cortexa-xpack/blob/xpack/LICENSE)\n[![CI on Push](https://github.com/micro-os-plus/devices-cortexa-xpack/workflows/CI%20on%20Push/badge.svg)](https://github.com/micro-os-plus/devices-cortexa-xpack/actions?query=workflow%3A%22CI+on+Push%22)\n[![GitHub issues](https://img.shields.io/github/issues/micro-os-plus/devices-cortexa-xpack.svg)](https://github.com/micro-os-plus/devices-cortexa-xpack/issues/)\n[![GitHub pulls](https://img.shields.io/github/issues-pr/micro-os-plus/devices-cortexa-xpack.svg)](https://github.com/micro-os-plus/devices-cortexa-xpack/pulls)\n\n# Maintainer info\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\nIt is recommended to update to the latest version with:\n\n```sh\nnpm install --global xpm@latest\n```\n\n## Project repository\n\nThe project is hosted on GitHub as:\n\n- \u003chttps://github.com/micro-os-plus/devices-cortexa-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/devices-cortexa-xpack.git \u0026\u0026 \\\nmkdir -p ~/Work \u0026\u0026 \\\ngit clone \\\n  https://github.com/micro-os-plus/devices-cortexa-xpack.git \\\n  ~/Work/devices-cortexa-xpack.git\n```\n\nFor development purposes, clone the `xpack-develop` branch:\n\n```sh\nrm -rf ~/Work/devices-cortexa-xpack.git \u0026\u0026 \\\nmkdir -p ~/Work \u0026\u0026 \\\ngit clone \\\n  --branch xpack-develop \\\n  https://github.com/micro-os-plus/devices-cortexa-xpack.git \\\n  ~/Work/devices-cortexa-xpack.git\n```\n\n## Development setup\n\n### Remove previous packages\n\nIn this early development phase, package versions are not properly set, and\nif you have older versions of the xPack installed, sometimes updates may fail\nto get the latest version. To fix this remove all global packages by using\n\n```sh\ncd ~/Work/devices-cortexa-xpack.git\nxpm run rm-global-deps\n```\n\nand repeat the steps from `xpm install`.\n\n### Install dependencies\n\nWith a clean slate, install dependencies:\n\n```sh\ncd ~/Work/devices-cortexa-xpack.git\nxpm run install-all\n```\n\n## Run tests\n\nThe project includes unit tests.\n\nTo perform the tests, run the usual xpm sequence:\n\n```sh\ncd ~/Work/devices-cortexa-xpack.git\nxpm run test-all\n```\n\n### Clone writeable dependencies\n\nThe above procedure will allow to develop the project itself, but the\ndependencies will be read-only; to be able to contribute to them,\nalso clone the `xpack-develop` branches of all µOS++ source xPacks\ninto a folder of your choice and link them to the central xPacks\nfolder by running `xpack link` in each folder.\n\nTo automate this, there is a helper script to clone these repos into\n`${HOME}/Work/micro-os-plus-xpack-repos`:\n\n```sh\ncurl -L https://raw.githubusercontent.com/micro-os-plus/helper-scripts/main/clone-and-link-all-git-repos.sh | bash -\n```\n\nNote: If you prefer a different location, start the script with a first\nargument as the destination folder path.\n\nAfter cloning all Git repos, link this project to the development packages,\nby running the `link-deps` actions:\n\n```sh\ncd devices-cortexa-xpack.git\nxpm run link-deps\n```\n\n## Continuous Integration\n\nThe CI tests are performed on GitHub Actions, as the\n[CI on Push](https://github.com/micro-os-plus/devices-cortexa-xpack/actions?query=workflow%3A%22CI+on+Push%22)\nworkflow.\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\n## How to publish\n\n### Publish on the npmjs.com server\n\n- select the `xpack-develop` branch\n- commit all changes\n- update versions in `README.md` and `README-MAINTAINER.md`\n- update `CHANGELOG.md`\n- commit with a message like _prepare v2.0.0_\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-develop` 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/devices-cortexa-xpack/actions/workflows/CI.yml\u003e)\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/devices-cortexa?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-develop` into `xpack`\n- push to GitHub\n- select `xpack-develop`\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/devices-cortexa`\n- `npm dist-tag add @micro-os-plus/devices-cortexa@2.0.0 latest`\n- `npm dist-tag ls @micro-os-plus/devices-cortexa`\n\n## Share on Twitter\n\n- in a separate browser windows, open [TweetDeck](https://tweetdeck.twitter.com/)\n- using the `@micro_os_plus` account\n- paste the release name like **µOS++ devices-cortexa v2.0.0 released**\n- paste the link to the Web page release\n- click the **Tweet** button\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicro-os-plus%2Fdevices-cortexa-xpack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicro-os-plus%2Fdevices-cortexa-xpack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicro-os-plus%2Fdevices-cortexa-xpack/lists"}