Skip to content

Commit

Permalink
Update to Node 16 (#256)
Browse files Browse the repository at this point in the history
* Use Node 16

* Update changeset packages

* Update READMEs with basic details

* Add changeset
  • Loading branch information
elidupuis authored Jan 11, 2024
1 parent 34dede2 commit 7ece826
Show file tree
Hide file tree
Showing 6 changed files with 608 additions and 294 deletions.
8 changes: 8 additions & 0 deletions .changeset/popular-schools-add.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
'@showbie/backpack-tokens': minor
'@showbie/backpack-react': minor
'@showbie/generator-backpack': minor
'stickerbomb': minor
---

Upgrade to Node 16
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ jobs:
fetch-depth: 0

# https://github.com/actions/setup-node/
- name: Setup Node.js 12.x
- name: Setup Node.js 16.x
uses: actions/setup-node@v2.5.1
with:
node-version: 12.x
node-version: 16.x
registry-url: https://npm.pkg.github.com

# https://github.com/bahmutov/npm-install
Expand Down
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
16
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Showbie Backpack

This project manages and publishes a few [npm packages](https://github.com/orgs/showbie/packages?repo_name=backpack) to the Github Package Registry under the `@showbie` scope.

## Development

Install the proper Node version and install dependencies:

```sh
# https://github.com/nvm-sh/nvm
nvm use
yarn install
```

<details>
<summary>Dont' have `yarn` installed?</summary>

Note, if you don't have `yarn`, simply install v1 from npm (this project has not been updated to modern yarn):

```sh
npm install -g yarn
```
</details>

### Build

To build the entire project:

```sh
yarn build
```

Each package should have its own README so be sure to check those out.

### Changelog

This project uses [changesets](https://github.com/changesets/changesets) to manage the changelog. This is integrated into Github actions and when you create a PR it will give you instructions on how to create a changeset, which is required for each PR.

```sh
# tl;dr
yarn changeset
```
16 changes: 16 additions & 0 deletions packages/backpack-tokens/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,19 @@
![GitHub package.json version](https://img.shields.io/github/package-json/v/showbie/backpack-tokens)

A design token is an abstraction of a visual property such as colour, font, width, animation, etc. These raw values are language-agnostic and once transformed and formatted can be used on any platform.

## Development

See the `src` directory to update the colour tokens for Showbie and Socrative.
Any changes here will be built by the logic and templates in the `lib` directory and then released
in the `@showbie/backpack-tokens` npm package. The releases are triggered in Github Actions
via changeset workflows.

### Docs Site (vuepress)

There is also Vuepress documentation site in the `docs` directory. To run the docs site locally:

```sh
cd packages/backpack-tokens
yarn docs:dev
```
Loading

0 comments on commit 7ece826

Please sign in to comment.