Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/micro-os-plus/devices-stm32f4-extras-xpack
A source xPack with complementary STM32F4 files
https://github.com/micro-os-plus/devices-stm32f4-extras-xpack
Last synced: about 2 months ago
JSON representation
A source xPack with complementary STM32F4 files
- Host: GitHub
- URL: https://github.com/micro-os-plus/devices-stm32f4-extras-xpack
- Owner: micro-os-plus
- License: mit
- Created: 2021-02-04T20:01:45.000Z (almost 4 years ago)
- Default Branch: xpack
- Last Pushed: 2023-11-28T21:10:05.000Z (about 1 year ago)
- Last Synced: 2024-11-06T08:45:56.512Z (3 months ago)
- Language: C
- Homepage:
- Size: 110 KB
- Stars: 0
- Watchers: 3
- 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/devices-stm32f4-extras-xpack/blob/xpack/LICENSE)
[](https://github.com/micro-os-plus/devices-stm32f4-extras-xpack/actions?query=workflow%3A%22CI+on+Push%22)
[](https://github.com/micro-os-plus/devices-stm32f4-extras-xpack/issues/)
[](https://github.com/micro-os-plus/devices-stm32f4-extras-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/devices-stm32f4-extras-xpack.git && \
mkdir -p ~/Work && \
git clone \
https://github.com/micro-os-plus/devices-stm32f4-extras-xpack.git \
~/Work/devices-stm32f4-extras-xpack.git && \
git -C ~/Work/devices-stm32f4-extras-xpack.git submodule update --init --recursive
```
For development purposes, clone the `xpack-develop` branch:
```sh
rm -rf ~/Work/devices-stm32f4-extras-xpack.git && \
mkdir -p ~/Work && \
git clone \
--branch xpack-develop \
https://github.com/micro-os-plus/devices-stm32f4-extras-xpack.git \
~/Work/devices-stm32f4-extras-xpack.git && \
git -C ~/Work/devices-stm32f4-extras-xpack.git submodule update --init --recursive
```
## Regenerate vectors_*.c
```sh
version=1.25.2
bash scripts/helper/generate-vectors-from-arm-startup.sh \
${HOME}/STM32Cube/Repository/STM32Cube_FW_F4_V${version}/Drivers/CMSIS/Device/ST/STM32F4xx/Source/Templates/arm \
src/vectors
```
## 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.
## Prepare a new blog post
In the `micro-os-plus/web-jekyll` GitHub repo:
- select the `develop` branch
- add a new file to `_posts/devices-stm32f4-extras/releases`
- name the file like `2020-12-19-devices-stm32f4-v1-1-0-released.md`
- name the post like: **µOS++ devices-stm32f4 v2.2.2 released**
- update the `date:` field with the current date
- update the GitHub Actions URLs using the actual test pages
If any, refer to closed
[issues](https://github.com/micro-os-plus/devices-stm32f4-extras-xpack/issues/)
as:
- **[Issue:\[#1\]\(...\)]**.
## 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 v2.2.2_
- `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 devices-stm32f4-extras-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-stm32f4-extras-xpack/actions?query=workflow%3A%22CI+on+Push%22)
workflow.
## Update the repo
When the package is considered stable:
- with Sourcetree
- 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-stm32f4-extras`
- `npm dist-tag add @micro-os-plus/[email protected] latest`
- `npm dist-tag ls @@micro-os-plus/devices-stm32f4-extras`
## Announce to the community
Post an announcement to the forum.
## 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++ devices-stm32f4 v2.2.2 released**
- paste the link to the Web page release
- click the **Tweet** button