Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 2 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,16 +53,7 @@ To install React UI in your app:
npm install --save @react-ui-org/react-ui
```

2. Load the Titillium Web font:

```html
<link
href="https://fonts.googleapis.com/css2?family=Titillium+Web:wght@300;400;600;700&display=swap"
rel="stylesheet"
/>
```

3. Load React UI CSS in your app:
2. Load React UI CSS in your app:

<!-- eslint-env browser -->
<!-- eslint-disable import/no-unresolved -->
Expand All @@ -73,7 +64,7 @@ To install React UI in your app:

<!-- eslint-env browser -->

4. Import and use any of React UI components in your app:
3. Import and use any of React UI components in your app:

```jsx
import { Button } from '@react-ui-org/react-ui';
Expand Down
47 changes: 24 additions & 23 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ In order for the automation to work properly, contributors must follow the
1. Pull requests are automatically labelled by branch name. Labels are then used
for:

1. resolving next [semantic version number][semver]
(BREAKING.FEATURE.PATCH),
2. grouping changes in changelog.
1. resolving next [semantic version number][semver]
(BREAKING.FEATURE.PATCH),
2. grouping changes in changelog.

2. Release draft with changelog is generated as pull requests are merged into
the `master` branch. Invididual PR names are listed and grouped by type based
Expand All @@ -30,35 +30,36 @@ See the source of `.github/workflows` for details.
[GitHub releases page][gh-releases] to see what the changelog looks like and
what will be the next version number.

**Don't edit manually until you are ready to publish the release.** Release
draft is automatically overwritten everytime a change is merged to `master`.
**Don't edit manually until you are ready to publish the release.** Release
draft is automatically overwritten everytime a change is merged to `master`.

2. **Manual:** once you are ready to publish a release:

1. **Bump the version number** in `package.json` and `package-lock.json`.
Make sure it matches the intended version number in the release draft.
**Don't combine this step with any other changes,** they wouldn't be
reflected in the changelog.
1. **Bump the version number** in `package.json` and `package-lock.json`.
Make sure it matches the intended version number in the release draft.
**Don't combine this step with any other changes,** they wouldn't be
reflected in the changelog.

2. Now is also your **chance to review and adjust (if necessary) the intended
version and actual changelog before the release is published.**
Automatic release drafting is skipped when a version change in
`package.json` is detected so this time your changes will not be
overwritten. Save your changes in release draft with the _Save draft_
button, **do not publish** yet!
2. Now is also your **chance to review and adjust (if necessary) the
intended
version and actual changelog before the release is published.**
Automatic release drafting is skipped when a version change in
`package.json` is detected so this time your changes will not be
overwritten. Save your changes in release draft with the _Save draft_
button, **do not publish** yet!

3. Get back to the repository, commit both files as
`Bump version to <VERSION_NUMBER>` in `release/<VERSION_NUMBER>` branch,
create a pull request, hold your breath, and—merge it.
3. Get back to the repository, commit both files as
`Bump version to <VERSION_NUMBER>` in `release/<VERSION_NUMBER>` branch,
create a pull request, hold your breath, and—merge it.

3. **Automatic:** once the release pull request from step 2.3 is merged, the
following actions are triggered automatically:

1. GitHub release draft with name corresponding to the version number from
step 2 is published.
2. Git tag with the version number from step 2 is added to `master` branch.
3. Package is built and published to npm package registry.
4. Documentation is built and deployed to production.
1. GitHub release draft with name corresponding to the version number from
step 2 is published.
2. Git tag with the version number from step 2 is added to `master` branch.
3. Package is built and published to npm package registry.
4. Documentation is built and deployed to production.

**Note:** prefix version number with `v` everywhere except in `package.json` and
`package-lock.json`.
Expand Down
3 changes: 1 addition & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,6 @@ theme:
language: 'en'
favicon: 'favicon.ico'
custom_dir: 'src/docs/_overrides'
font:
text: 'Titillium Web'
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
Expand Down Expand Up @@ -135,6 +133,7 @@ nav:
- TransferProps: 'helpers/transferProps/README.md'
- Guides:
- Customize:
- Font: 'docs/customize/font.md'
- Theming:
- Overview: 'docs/customize/theming/overview.md'
- Forms: 'docs/customize/theming/forms.md'
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
"precopy": "rm -rf dist && mkdir dist",
"prepublishOnly": "npm run build",
"start": "webpack --watch --mode=development",
"stylelint": "stylelint \"src/**/*.scss\" --config stylelint.config.js",
"stylelint": "stylelint \"src/**/*.{css,scss}\" \"!src/docs/_assets/generated/**\" --config stylelint.config.js",
"test": "npm run jest"
},
"dependencies": {
Expand Down
Loading