Skip to content

Commit

Permalink
feat: beta release (#1445)
Browse files Browse the repository at this point in the history
Relates to #1275, #853

When merging this PR, all packages will be published as version
`1.0.0-beta.0`.
You can verify this by running `npx changeset version` locally.

This PR includes:

- configure changeset to release beta versions from now on
- update all docs to `beta` instead of `alpha`
- include all changelogs in search
- fix tab title for changelog pages
- update component implemented status on home page
  • Loading branch information
larsrickert authored Jul 4, 2024
1 parent 7e12535 commit bf3ea0a
Show file tree
Hide file tree
Showing 70 changed files with 100 additions and 81 deletions.
18 changes: 18 additions & 0 deletions .changeset/fresh-lemons-fetch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
"playground": major
"docs": major
"demo-app": major
"@sit-onyx/chartjs-plugin": major
"@sit-onyx/eslint-plugin": major
"@sit-onyx/figma-utils": major
"@sit-onyx/headless": major
"@sit-onyx/icons": major
"@sit-onyx/nuxt": major
"sit-onyx": major
"@sit-onyx/storybook-utils": major
"@sit-onyx/vitepress-theme": major
---

release beta version

🎉 onyx is now beta! There are no breaking changes to the last `1.0.0.-alpha.*` version
4 changes: 2 additions & 2 deletions .changeset/pre.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"mode": "pre",
"tag": "alpha",
"tag": "beta",
"initialVersions": {
"@sit-onyx/chartjs-plugin": "0.0.0",
"@sit-onyx/figma-utils": "0.0.0",
Expand All @@ -11,7 +11,7 @@
"@sit-onyx/vitepress-theme": "0.0.0",
"docs": "0.0.0",
"@sit-onyx/eslint-plugin": "0.0.0",
"alpha-test-app": "0.0.0",
"demo-app": "0.0.0",
"playground": "0.0.0",
"@sit-onyx/nuxt": "0.0.0"
},
Expand Down
2 changes: 1 addition & 1 deletion .changeset/three-icons-leave.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
"alpha-test-app": minor
"demo-app": minor
"sit-onyx": minor
---

Expand Down
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@

A design system and Vue.js component library for enterprise grade applications created by [Schwarz IT](https://it.schwarz).

> **Work in progress**: This library is currently in early / active development.
<br>
<br />

## Documentation

Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Supported Versions

onyx is currently still in alpha development. Once we published 1.0.0 of our packages, we'll show the information on wich versions of which packages are being supported with security updates below.
onyx is currently still in beta development. Once we published 1.0.0 of our packages, we'll show the information on wich versions of which packages are being supported with security updates below.

## Reporting a Vulnerability

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# alpha-test-app
# demo-app

## 0.1.0-alpha.162

Expand Down
10 changes: 5 additions & 5 deletions apps/alpha-test-app/README.md → apps/demo-app/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Alpha Test App
# Demo App

During the alpha phase of onyx, we use this minimalistic app to try out onyx components in a user-near environment and detect problems that Storybook can not show.
This app will be removed once onyx leaves the alpha phase. As it is temporary, it will not be mentioned in our documentation app.
During the pre-release phase of onyx, we use this minimalistic app to try out onyx components in a user-near environment and detect problems that Storybook can not show.
This app will be removed once onyx leaves the pre-release phase. As it is temporary, it will not be mentioned in our documentation app.

**Important**: To see changes that you implemented in onyx, make sure to run `pnpm dev` again which includes the build command for onyx. Only then will the changes be reflected in the Alpha Test App.
**Important**: To see changes that you implemented in onyx, make sure to run `pnpm dev` again which includes the build command for onyx. Only then will the changes be reflected in the Demo App.

## Vue 3 + TypeScript + Vite

This app was created with `pnpm create vite alpha-test-app --template vue-ts`.
This app was created with `pnpm create vite demo-app --template vue-ts`.

Below documentation was kept from the starter-app.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="UTF-8" />
<link rel="icon" type="image/x-icon" href="favicon.ico" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>onyx Alpha Test App</title>
<title>onyx Demo App</title>
</head>
<body>
<div id="app"></div>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"name": "alpha-test-app",
"name": "demo-app",
"private": true,
"version": "0.1.0-alpha.162",
"version": "0.0.0",
"type": "module",
"scripts": {
"start": "pnpm run dev",
"dev": "cd ../../packages/sit-onyx && pnpm build && cd ../../apps/alpha-test-app && vite",
"dev": "cd ../../packages/sit-onyx && pnpm build && cd ../../apps/demo-app && vite",
"build": "vue-tsc && vite build",
"preview": "vite preview"
},
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ watch(
>
<OnyxNavBar
ref="navBarRef"
app-name="Alpha Test App"
app-name="Demo App"
:logo-url="onyxLogo"
show-back-button
@back-button-click="router.back"
Expand Down
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion apps/docs/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "docs",
"version": "0.1.0-alpha.4",
"version": "0.0.0",
"type": "module",
"private": true,
"scripts": {
Expand Down
6 changes: 3 additions & 3 deletions apps/docs/src/.vitepress/components/ComponentRoadmap.vue
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,9 @@ const shouldShowAllButton = computed(() => {
<OnyxHeadline is="h2" class="components__headline">Components</OnyxHeadline>

<p class="components__description">
onyx is currently in early / active development. Below you can find a list of components that
we are planning to implement as well as their estimated due date. Feel free to check this page
regularly, we will keep it up to date with our progress.
onyx is currently in beta version and early / active development. Below you can find a list of
components that we are planning to implement as well as their estimated due date. Feel free to
check this page regularly, we will keep it up to date with our progress.
</p>

<p class="components__description">
Expand Down
6 changes: 1 addition & 5 deletions apps/docs/src/development/density.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
# Density System

::: warning Work in progress / Active development
This library is currently in early / active development.
:::

Density refers to the amount of vertical white space a component has, as well as the height of the main (interactive) element of a component.
You can find more details about the design perspective in the [Density Design Doc](../basics/density.md).
You can find more details about the design perspective in the [density design documentation](../basics/density.md).

The density can be set for the whole app, part of the app or a single component using the following CSS classes:

Expand Down
14 changes: 7 additions & 7 deletions apps/docs/src/development/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ outline: [2, 3]

# Getting Started

::: warning Work in progress / Active development
This library is currently in early / active development.
:::

<div class="hide-external-link">

[![npm version](https://badge.fury.io/js/sit-onyx.svg)](https://www.npmjs.com/package/sit-onyx)

</div>

## Changelog

A full changelog can be found [here](/development/packages/changelogs/sit-onyx).

## Nuxt

If you are using [Nuxt](https://nuxt.com), please head over to our [Nuxt module documentation](/development/packages/nuxt) to get started.
Expand All @@ -25,15 +25,15 @@ Install the npm package with your corresponding package manager:
::: code-group

```sh [pnpm]
pnpm add sit-onyx@alpha
pnpm add sit-onyx@beta
```

```sh [npm]
npm install sit-onyx@alpha
npm install sit-onyx@beta
```

```sh [yarn]
yarn install sit-onyx@alpha
yarn install sit-onyx@beta
```

:::
Expand Down
9 changes: 8 additions & 1 deletion apps/docs/src/development/packages/changelogs/[name].md
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
---
title: Changelog
---

<script lang="ts" setup>
import { useData } from "vitepress";
import { ref } from "vue";

const { params } = useData();
</script>

# Changelog

Below you can find a full list of changes for the current and previous versions.

<div v-if="params.name === 'figma-utils'">

<!--@include: @/../../../packages/figma-utils/CHANGELOG.md-->
Expand Down
6 changes: 3 additions & 3 deletions apps/docs/src/development/packages/chartjs-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,15 @@ Install the npm package with your corresponding package manager:
::: code-group

```sh [pnpm]
pnpm add @sit-onyx/chartjs-plugin@alpha chart.js
pnpm add @sit-onyx/chartjs-plugin@beta chart.js
```

```sh [npm]
npm install @sit-onyx/chartjs-plugin@alpha chart.js
npm install @sit-onyx/chartjs-plugin@beta chart.js
```

```sh [yarn]
yarn install @sit-onyx/chartjs-plugin@alpha chart.js
yarn install @sit-onyx/chartjs-plugin@beta chart.js
```

:::
Expand Down
8 changes: 4 additions & 4 deletions apps/docs/src/development/packages/figma-utils.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ A full changelog can be found [here](/development/packages/changelogs/figma-util
For a list of supported commands and options, run:

```sh
npx @sit-onyx/figma-utils@alpha --help
npx @sit-onyx/figma-utils@beta --help
```

::: tip Usage in CI
Expand All @@ -48,15 +48,15 @@ Install the npm package with your corresponding package manager:
::: code-group

```sh [pnpm]
pnpm add @sit-onyx/figma-utils@alpha
pnpm add @sit-onyx/figma-utils@beta
```

```sh [npm]
npm install @sit-onyx/figma-utils@alpha
npm install @sit-onyx/figma-utils@beta
```

```sh [yarn]
yarn install @sit-onyx/figma-utils@alpha
yarn install @sit-onyx/figma-utils@beta
```

:::
Expand Down
10 changes: 3 additions & 7 deletions apps/docs/src/development/packages/headless.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,6 @@ import packageJson from "../../../../../packages/headless/package.json";

</div>

::: warning Work in progress / Active development
This library is currently in early / active development.
:::

{{ packageJson.description }}.

Inspired by [Melt UI](https://melt-ui.com).
Expand All @@ -33,15 +29,15 @@ Install the npm package with your corresponding package manager:
::: code-group

```sh [pnpm]
pnpm add @sit-onyx/headless@alpha
pnpm add @sit-onyx/headless@beta
```

```sh [npm]
npm install @sit-onyx/headless@alpha
npm install @sit-onyx/headless@beta
```

```sh [yarn]
yarn install @sit-onyx/headless@alpha
yarn install @sit-onyx/headless@beta
```

:::
Expand Down
4 changes: 4 additions & 0 deletions apps/docs/src/development/packages/icons.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,7 @@ import packageJson from "../../../../../packages/icons/package.json";
{{ packageJson.description }}.

Please visit the [icon resources](/icons) for a full list of icons as well as technical instructions.

## Changelog

A full changelog can be found [here](/development/packages/changelogs/icons).
2 changes: 1 addition & 1 deletion apps/docs/src/development/packages/nuxt.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ A full changelog can be found [here](/development/packages/changelogs/nuxt).
Install the module in your [Nuxt](https://nuxt.com) application with one command:

```sh
npx nuxi module add @sit-onyx/nuxt@alpha
npx nuxi module add @sit-onyx/nuxt@beta
```

If you are also using the [@nuxtjs/i18n](https://i18n.nuxtjs.org/) module, make sure to move `@sit-onyx/nuxt` **before** `@nuxtjs/i18n`.
Expand Down
6 changes: 3 additions & 3 deletions apps/docs/src/development/packages/storybook-utils.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@ Install the npm package with your corresponding package manager:
::: code-group

```sh [pnpm]
pnpm add -D @sit-onyx/storybook-utils@alpha
pnpm add -D @sit-onyx/storybook-utils@beta
```

```sh [npm]
npm install -D @sit-onyx/storybook-utils@alpha
npm install -D @sit-onyx/storybook-utils@beta
```

```sh [yarn]
yarn install -D @sit-onyx/storybook-utils@alpha
yarn install -D @sit-onyx/storybook-utils@beta
```

:::
Expand Down
6 changes: 3 additions & 3 deletions apps/docs/src/development/packages/vitepress-theme.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,15 @@ The theme includes the following features:
::: code-group

```sh [pnpm]
pnpm add -D @sit-onyx/vitepress-theme@alpha
pnpm add -D @sit-onyx/vitepress-theme@beta
```

```sh [npm]
npm install -D @sit-onyx/vitepress-theme@alpha
npm install -D @sit-onyx/vitepress-theme@beta
```

```sh [yarn]
yarn install -D @sit-onyx/vitepress-theme@alpha
yarn install -D @sit-onyx/vitepress-theme@beta
```

:::
Expand Down
6 changes: 3 additions & 3 deletions apps/docs/src/icons.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ To get started, install the npm package with your corresponding package manager:
::: code-group

```sh [pnpm]
pnpm add -D @sit-onyx/icons@alpha
pnpm add -D @sit-onyx/icons@beta
```

```sh [npm]
npm install -D @sit-onyx/icons@alpha
npm install -D @sit-onyx/icons@beta
```

```sh [yarn]
yarn install -D @sit-onyx/icons@alpha
yarn install -D @sit-onyx/icons@beta
```

:::
Expand Down
Loading

0 comments on commit bf3ea0a

Please sign in to comment.