Skip to content

Commit

Permalink
chore: set up version 14, clean up further Ruby references in README
Browse files Browse the repository at this point in the history
  • Loading branch information
jamiehenson committed Mar 27, 2024
1 parent 6e22efb commit 95a7587
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 17 deletions.
24 changes: 8 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,16 +127,10 @@ Putting SVG files inside a`src/MODULE_NAME/icons` folder will add them to a per-

Usage with the `Icon` React component:

```jsx
```tsx
<Icon name="icon-display-live-chat" size="3rem" additionalCSS="block mb-16" />
```

Usage with `Icon` VW component:

```rb
<%= render(AblyUi::Core::Icon.new(name: "icon-gui-disclosure-arrow", size: "1rem", additional_css: "align-middle transform rotate-180 mr-4")) %>
```
Usage without a component:

```html
Expand All @@ -148,7 +142,7 @@ Usage without a component:

Usage without a component, in React, with hover states. Note the [group](https://tailwindcss.com/docs/hover-focus-and-other-states#group-hover) class:

```jsx
```tsx
<a
href="{url}"
className="text-gui-default hover:text-gui-hover focus:text-gui-focus group"
Expand Down Expand Up @@ -213,7 +207,7 @@ This script is a combination of two scripts:
1. Pre-Release:

- update your local dependencies for ably-ui and run a production build
- release a gem and a NPM package with the version built from your current SemVer but adding a pre-release tag based on a short SHA of your HEAD commit
- release an NPM package with the version built from your current SemVer but adding a pre-release tag based on a short SHA of your HEAD commit

2. Update Pre-Release Version:

Expand Down Expand Up @@ -262,10 +256,10 @@ By default, [Prettier](https://prettier.io/) & [ESLint](https://eslint.org/) wil
#### To add a new component:

1. Create a folder in `src`, in the module of your choice (i.e. `core`). The folder name should be TitleCase.
2. Add a `component.js`
2. Add a `component.tsx`

- if the component has custom CSS, add a `component.css` file as well. Import the CSS file in `component.js`
- if you need a VW component, add `component.rb` and `component.html.erb`
- also add an empty `component.js` file (current legacy requirement)
- if the component has custom CSS, add a `component.css` file as well.

#### To see this component in Storybook:

Expand All @@ -277,13 +271,13 @@ We use [Semantic Versioning 2.0.0](https://semver.org/) to version different lib

Packages are published to the [GitHub private registry](https://github.com/features/packages).

Publishing is done by tagging a release in GitHub. This triggers a GitHub action that pushes to the private NPM and gem registries as well as publishing new artefacts in the CDN, with the version taken from the tag of the GitHub release. ⚠️
Publishing is done by tagging a release in GitHub. This triggers a GitHub action that pushes to the private NPM registry as well as publishing new artefacts in the CDN, with the version taken from the tag of the GitHub release.

This will trigger GitHub actions in supported apps (currently [Voltaire](http://github.com/ably/voltaire) & [Website](http://github.com/ably/website)) to create a PR with an ably-ui version update.

**To trigger a release:**

- Make sure you have run pre-release script `./pre-release.sh` (This updates the npm package version for ably-ui in the following files `Gemfile`, `package.json`).
- Make sure you have run pre-release script `./pre-release.sh` (This updates the npm package version for ably-ui in `package.json`).
- Merge your PR into `main` after it has been approved.
- On the Github [Ably-UI](http://github.com/ably/ably-ui) repo, [create a new release](https://github.com/ably/ably-ui/releases/new) tag.
- Create a new tag with the new version number for the release.
Expand All @@ -296,8 +290,6 @@ This will trigger GitHub actions in supported apps (currently [Voltaire](http://

This will release the packages, update library & preview app and create & push the commit & tag, and also create corresponding PRs in Voltaire & Website.

_Note: If the version number of the gem has been yanked you will need to increment the version number._

### Running tests

The repo includes [Cypress](https://www.cypress.io/) for snapshot, screenshot, parity and behaviour testing. Cypress runs against the "preview" server (e.g. the same server used for development).
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@ably/ui",
"version": "13.2.2-dev.78815ed",
"version": "14.0.0",
"description": "Home of the Ably design system library ([design.ably.com](https://design.ably.com)). It provides a showcase, development/test environment and a publishing pipeline for different distributables.",
"repository": {
"type": "git",
Expand Down

0 comments on commit 95a7587

Please sign in to comment.