Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/micro-os-plus/platform-sifive-hifive1-xpack

A source xPack with the µOS++ support for the SiFive HiFive1 board
https://github.com/micro-os-plus/platform-sifive-hifive1-xpack

Last synced: about 1 month ago
JSON representation

A source xPack with the µOS++ support for the SiFive HiFive1 board

Host: GitHub
URL: https://github.com/micro-os-plus/platform-sifive-hifive1-xpack
Owner: micro-os-plus
License: mit
Created: 2017-09-04T21:57:09.000Z (over 7 years ago)
Default Branch: xpack
Last Pushed: 2023-11-28T21:10:24.000Z (about 1 year ago)
Last Synced: 2024-08-10T19:28:41.881Z (5 months ago)
Language: C++
Homepage:
Size: 105 KB
Stars: 0
Watchers: 3
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README-MAINTAINER.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

[![license](https://img.shields.io/github/license/micro-os-plus/platform-sifive-hifive1-xpack)](https://github.com/micro-os-plus/platform-sifive-hifive1-xpack/blob/xpack/LICENSE)
[![CI on Push](https://github.com/micro-os-plus/platform-sifive-hifive1-xpack/workflows/CI%20on%20Push/badge.svg)](https://github.com/micro-os-plus/platform-sifive-hifive1-xpack/actions?query=workflow%3A%22CI+on+Push%22)
[![GitHub issues](https://img.shields.io/github/issues/micro-os-plus/platform-sifive-hifive1-xpack.svg)](https://github.com/micro-os-plus/platform-sifive-hifive1-xpack/issues)
[![GitHub pulls](https://img.shields.io/github/issues-pr/micro-os-plus/platform-sifive-hifive1-xpack.svg)](https://github.com/micro-os-plus/platform-sifive-hifive1-xpack/pulls)

# Maintainer info

## Project repository

The project is hosted on GitHub:

- https://github.com/micro-os-plus/platform-sifive-hifive1-xpack.git

To clone it:

```sh
git clone https://github.com/micro-os-plus/platform-sifive-hifive1-xpack.git platform-sifive-hifive1-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.

## Prepare a new blog post

In the `micro-os-plus/web-jekyll` GitHub repo:

- select the `develop` branch
- add a new file to `_posts/platform-sifive-hifive1/releases`
- name the file like `2020-12-19-platform-sifive-hifive1-v1-1-0-released.md`
- name the post like: **µOS++ platform-sifive-hifive1 v2.0.1 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/platform-sifive-hifive1/issues)
as:

- **[Issue:\[#1\]\(...\)]**.

## Publish on the npmjs.com server

- select the `xpack-develop` branch
- commit all changes
- update `CHANGELOG.md`; commit with a message like _CHANGELOG: prepare v2.0.1_
- `npm pack` and check the content of the archive, which should list
only the `package.json`, the `README.md`, `LICENSE` and `CHANGELOG.md`;
possibly adjust `.npmignore`
- `npm version patch`, `npm version minor`, `npm version major`
- push the `xpack-develop` branch to GitHub with `git push origin --tags`
- `npm publish --tag next` (use `--access public` when publishing for
the first time)

The version is visible at:

- https://www.npmjs.com/package/@xpack-sifive/platform-hifive1?activeTab=versions

## Testing

The project includes unit tests.

To run them, run:

```sh
cd platform-sifive-hifive1-xpack.git
xpm run install-all
xpm run test
```

## Continuous Integration

All available tests are also performed on GitHub Actions, as the
[CI on Push](https://github.com/micro-os-plus/platform-sifive-hifive1-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 @xpack-sifive/platform-hifive1`
- `npm dist-tag add @xpack-sifive/[email protected] latest`
- `npm dist-tag ls @@xpack-sifive/platform-hifive1`

## 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++ platform-sifive-hifive1 v2.0.1 released**
- paste the link to the Web page release
- click the **Tweet** button