Skip to content

Latest commit

 

History

History
110 lines (75 loc) · 3.61 KB

README-MAINTAINER.md

File metadata and controls

110 lines (75 loc) · 3.61 KB
Raw

license CI on Push GitHub issues GitHub pulls

Maintainer info

Project repository

The project is hosted on GitHub:

To clone it:

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

Prerequisites

A recent xpm, which is a portable Node.js 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-arty/releases
  • name the file like 2020-12-19-platform-sifive-arty-v1-1-0-released.md
  • name the post like: µOS++ platform-sifive-arty 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 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:

Testing

The project includes unit tests.

To run them, run:

cd platform-sifive-arty-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 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-arty
  • npm dist-tag add @xpack-sifive/platform-arty@2.0.1 latest
  • npm dist-tag ls @@xpack-sifive/platform-arty

Announce to the community

Post an announcement to the forum.

Share on Twitter

  • in a separate browser windows, open TweetDeck
  • using the @micro_os_plus account
  • paste the release name like µOS++ platform-sifive-arty v2.0.1 released
  • paste the link to the Web page release
  • click the Tweet button