Skip to content

Latest commit

 

History

History
129 lines (85 loc) · 4.02 KB

README-MAINTAINER-XPACK.md

File metadata and controls

129 lines (85 loc) · 4.02 KB
Raw

license CI on Push GitHub issues GitHub 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):

rm -rf ~/Work/xpack-3rd-party/raspberrypi-pico-sdk-xpack.git && \
mkdir -p ~/Work/xpack-3rd-party && \
git clone \
  https://github.com/xpack-3rd-party/raspberrypi-pico-sdk-xpack.git \
  ~/Work/xpack-3rd-party/raspberrypi-pico-sdk-xpack.git

For development purposes, clone the xpack-develop branch:

rm -rf ~/Work/xpack-3rd-party/raspberrypi-pico-sdk-xpack.git && \
mkdir -p ~/Work/xpack-3rd-party && \
git clone \
  --branch xpack-develop \
  https://github.com/xpack-3rd-party/raspberrypi-pico-sdk-xpack.git \
  ~/Work/xpack-3rd-party/raspberrypi-pico-sdk-xpack.git

Prerequisites

A recent xpm, which is a portable Node.js command line application.

How to make new releases

Release schedule

There are no fixed releases, the project aims to follow the upstream releases.

Check Git

In the xpack-3rd-party/raspberrypi-pico-sdk-xpack Git repo:

  • switch to the xpack-develop branch
  • if needed, merge the xpack branch

No need to add a tag here, it'll be added when the release is created.

Increase the version

Determine the upstream version (like 1.5.1)

Update thepackage.json file; add an extra digit in the pre-release field, and initially also add .pre, for example 1.5.1-1.pre.

Fix possible open issues

Check GitHub issues and pull requests:

and fix them; assign them to a milestone (like 1.5.1-1).

Update README-MAINTAINER.md

Update the following files to reflect the changes related to the new version:

  • README-MAINTAINER.md
  • README.md

Update CHANGELOG-XPACK.md

  • open the CHANGELOG-XPACK.md file
  • check if all previous fixed issues are in
  • add a new entry like * v1.5.1-1
  • commit with a message like prepare v1.5.1-1

Push changes

  • commit and push

Publish on the npmjs.com server

  • select the xpack-develop branch
  • commit all changes
  • npm pack and check the content of the archive, which should list only package.json, README.md, LICENSE, CHANGELOG-XPACK.md, the doxygen-awesome-*.js and doxygen-custom/* files; possibly adjust .npmignore
  • npm version 1.5.1-1
  • push the xpack-develop branch to GitHub
  • the postversion npm script should also update tags via git push origin --tags

Publish

  • npm publish --tag next (use npm publish --access public when publishing for the first time)

The version is visible at:

Update the repo

When the package is considered stable:

  • with a Git client (VS Code is fine)
  • 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-3rd-party/raspberrypi-pico-sdk
  • npm dist-tag add @xpack-3rd-party/[email protected] latest
  • npm dist-tag ls @xpack-3rd-party/raspberrypi-pico-sdk