Skip to content

Commit

Permalink
Merge branch 'main' into install_docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tobiasdiez authored Dec 5, 2024
2 parents aa65845 + 0c55366 commit d358e3c
Show file tree
Hide file tree
Showing 45 changed files with 9,394 additions and 12,665 deletions.
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
github: [tobiasdiez, chakAs3]
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: "\U0001F41E Bug report"
description: Create a report to help us improve Nuxt
labels: ['type: bug']
body:
- type: markdown
attributes:
value: "
### Search for existing issues
Please carefully [search for related issues (open and closed)](https://github.com/nuxt-modules/storybook/issues?q=is%3Aissue) and make sure you're not submitting a duplicate issue.
If you find anything that seems like the same bug, it's much better to comment on an existing thread than create a duplicate.
### Check nightly builds
We are constantly improving the module and it's possible that the issue you're experiencing has already been fixed in the latest nightly build.
Please try to reproduce the issue with the [latest nightly build](https://storybook.nuxtjs.org/getting-started/setup#nightly-builds) and see if it still persists.
"
- type: textarea
id: bug-env
attributes:
label: Environment
description: You can use `npx nuxi info` to fill this section
placeholder: Environment
validations:
required: true
- type: input
id: reproduction
attributes:
label: Reproduction
description:
It is important to provide a minimal reproduction of the issue you're experiencing. This makes it easier to understand the problem and to find a solution.
Issues without a reproduction might be closed immediately.

The best way to create a minimal reproduction is by modifying the [Showcase example](https://github.com/nuxt-modules/storybook/tree/main/examples/showcase),
and open a PR with the minimal changes that reproduce the issue.
Alternatively, you can use the [StackBlitz template](https://stackblitz.com/github/nuxt-modules/storybook/tree/main/examples/starter) to create a minimal reproduction.
placeholder: URL to the reproduction
validations:
required: true
- type: textarea
id: bug-description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
Please try not to insert an image but copy paste the error text.
placeholder: Bug description
validations:
required: true
- type: textarea
id: additional
attributes:
label: Additional context
description: If applicable, add any other context about the problem here
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: 📚 Documentation
url: https://storybook.nuxtjs.org/getting-started/setup
about: Check the documentation for usage and troubleshooting.
22 changes: 9 additions & 13 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,18 @@
<!---
☝️ PR title should follow conventional commits (https://conventionalcommits.org)
<!--
☝️ PR title should follow conventional commits (https://conventionalcommits.org).
In particular, the title should start with one of the following types:
- docs: 📖 Documentation (updates to the documentation or readme)
- fix: 🐞 Bug fix (a non-breaking change that fixes an issue)
- feat: ✨ New feature/enhancement (a non-breaking change that adds functionality or improves existing one)
- feat!/fix!: ⚠️ Breaking change (fix or feature that would cause existing functionality to change)
- chore: 🧹 Chore (updates to the build process or auxiliary tools and libraries)
-->

### 🔗 Linked issue

<!-- If it resolves an open issue, please link the issue here. For example "Resolves #123" -->

### ❓ Type of change

<!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply. -->

- [ ] 📖 Documentation (updates to the documentation or readme)
- [ ] 🐞 Bug fix (a non-breaking change that fixes an issue)
- [ ] 👌 Enhancement (improving an existing functionality)
- [ ] ✨ New feature (a non-breaking change that adds functionality)
- [ ] 🧹 Chore (updates to the build process or auxiliary tools and libraries)
- [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

### 📚 Description

<!-- Describe your changes in detail -->
Expand Down
31 changes: 27 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: ci
name: CI

on:
push:
Expand All @@ -7,6 +7,7 @@ on:
pull_request:
branches:
- main

jobs:
ci:
runs-on: ${{ matrix.os }}
Expand All @@ -16,8 +17,15 @@ jobs:
# Keep this in sync with the oldest Node.js version supported by the storybook
node: [18, 20]
os: [ubuntu-latest, windows-latest, macos-latest]
permissions:
contents: read
id-token: write
steps:
- uses: actions/checkout@v4
- name: Checkout
uses: actions/checkout@v4
with:
# Needed for the nightly release to calculate the version bump
fetch-depth: 0

- name: Install pnpm
uses: pnpm/action-setup@v3
Expand All @@ -27,6 +35,7 @@ jobs:
with:
node-version: ${{ matrix.node }}
cache: pnpm
registry-url: 'https://registry.npmjs.org'

- name: Install dependencies
run: pnpm install
Expand All @@ -40,13 +49,27 @@ jobs:
- name: Build
run: pnpm build

- name: Install Playwright Browsers
run: pnpm exec playwright install --with-deps

- name: Run Playwright tests
run: pnpm test:playwright

- name: Upload Playwright report
uses: actions/upload-artifact@v4
if: ${{ !cancelled() }}
with:
name: playwright-report-${{ runner.os }}-${{ matrix.node }}
path: playwright-report/
retention-days: 30

- name: Nightly release
if: |
github.event_name == 'push' &&
matrix.node == 20 &&
matrix.os == 'ubuntu-latest' &&
!contains(github.event.head_commit.message, '[skip-release]') &&
!startsWith(github.event.head_commit.message, 'docs')
run: pnpm publish --recursive --tag next --access public --report-summary --no-git-checks --force
run: pnpm nightly-release
env:
NODE_AUTH_TOKEN: ${{secrets.NPMJS_TOKEN}}
NODE_AUTH_TOKEN: ${{ secrets.NPMJS_TOKEN }}
58 changes: 58 additions & 0 deletions .github/workflows/e2e.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: E2E tests

on:
push:
branches:
- main
pull_request:
branches:
- main

jobs:
e2e-tests:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}-${{ matrix.os }}-${{ matrix.node }}
cancel-in-progress: true
name: 'Starter'
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
# Keep this in sync with the oldest Node.js version supported by the storybook
node: [18, 19, 20]
os: [ubuntu-latest, windows-latest, macos-latest]
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Install pnpm
uses: pnpm/action-setup@v3

- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node }}
cache: pnpm

- name: Install dependencies
run: pnpm install

- name: Build packages
run: pnpm package
env:
NODE_ENV: 'production'

- name: Create Sample Project
shell: pwsh
run: |
$packages=Get-ChildItem -Path packages -Recurse -Filter "*.tgz"
echo "$packages"
New-Item -Path ${{ runner.temp }}/example -ItemType Directory
pnpm dlx nuxt init ${{ runner.temp }}/example --packageManager pnpm
cd ${{ runner.temp }}/example
pnpm dlx storybook@0.0.0-pr-28607-sha-b9bf7d39 init
pnpm add $packages
- name: Build Storybook
run: pnpm build-storybook
working-directory: ${{ runner.temp }}/example
40 changes: 0 additions & 40 deletions .github/workflows/release.yml

This file was deleted.

4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,7 @@ storybook-static
# Test artifacts
coverage
tsconfig.vitest-temp.json
/test-results/
/playwright-report/
/blob-report/
/playwright/.cache/
3 changes: 1 addition & 2 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
{
"eslint.experimental.useFlatConfig": true,
"cSpell.words": ["composables", "dedupe", "nuxt", "ofetch", "Pinia"]
"cSpell.words": ["composables", "dedupe", "nuxt", "nuxtjs", "ofetch", "Pinia"]
}
101 changes: 101 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,106 @@
# Changelog

## v8.3.2

[compare changes](https://github.com/nuxt-modules/storybook/compare/v8.3.1...v8.3.2)

### 📖 Documentation

- Module will not automatically generate a basic configuration ([#797](https://github.com/nuxt-modules/storybook/pull/797))

### 🏡 Chore

- **ci:** Update CI workflow to use nightly-release change the script name ([#806](https://github.com/nuxt-modules/storybook/pull/806))

### ❤️ Contributors

- Chakir QATAB ([@chakAs3](http://github.com/chakAs3))
- Luca-smartpricing ([@luca-smartpricing](http://github.com/luca-smartpricing))

## v8.3.1

[compare changes](https://github.com/nuxt-modules/storybook/compare/v8.3.0...v8.3.1)

## v8.3.0

[compare changes](https://github.com/nuxt-modules/storybook/compare/v8.2.0...v8.3.0)

### 🚀 Enhancements

- Exposing the https options for Storybook dev server ([#772](https://github.com/nuxt-modules/storybook/pull/772))

### 🩹 Fixes

- ⚠️ Properly handle context when using multiple nuxt instances ([#762](https://github.com/nuxt-modules/storybook/pull/762))
- Remove Storybook version from `storybook.ts` ([#778](https://github.com/nuxt-modules/storybook/pull/778))
- Suppress fetch type warning ([#787](https://github.com/nuxt-modules/storybook/pull/787))

### 🏡 Chore

- Remove unused jsdom dev dependency ([#766](https://github.com/nuxt-modules/storybook/pull/766))
- Add github bug report template ([#769](https://github.com/nuxt-modules/storybook/pull/769))
- Add GitHub funding information ([#770](https://github.com/nuxt-modules/storybook/pull/770))
- Add playwright tests ([#783](https://github.com/nuxt-modules/storybook/pull/783))
- Pin @storybook/\* packages ([#785](https://github.com/nuxt-modules/storybook/pull/785))

#### ⚠️ Breaking Changes

- ⚠️ Properly handle context when using multiple nuxt instances ([#762](https://github.com/nuxt-modules/storybook/pull/762))

### ❤️ Contributors

- Daniel Roe ([@danielroe](http://github.com/danielroe))
- Tobias Diez <code@tobiasdiez.de>
- Olga Bulat ([@obulat](http://github.com/obulat))
- Brandon ([@brandondv](http://github.com/brandondv))

## v8.2.0

[compare changes](https://github.com/nuxt-modules/storybook/compare/v8.1.5...v8.2.0)

### 🚀 Enhancements

- Export types also from `@nuxtjs/storybook` ([#749](https://github.com/nuxt-modules/storybook/pull/749))

### 🩹 Fixes

- Update Vite configs to include lodash/kebabCase in optimizeDeps ([#715](https://github.com/nuxt-modules/storybook/pull/715))
- Fix error due to import json attribute (and deactivate storybook version check) ([#722](https://github.com/nuxt-modules/storybook/pull/722))
- Resolve module not found error '@storybook/builder-vite' ([#724](https://github.com/nuxt-modules/storybook/pull/724))
- Correctly load the storybook preview annotation ([#726](https://github.com/nuxt-modules/storybook/pull/726))
- Remove Nuxt context conflict ([#723](https://github.com/nuxt-modules/storybook/pull/723))
- Update storybook version to 8.2.7 ([#739](https://github.com/nuxt-modules/storybook/pull/739))

### 📖 Documentation

- Add instructions for opting in and out of nightly builds ([#748](https://github.com/nuxt-modules/storybook/pull/748))
- Nightly release dependency package name ([#750](https://github.com/nuxt-modules/storybook/pull/750))

### 🏡 Chore

- Fix build and chromatic ([#708](https://github.com/nuxt-modules/storybook/pull/708))
- Pin dependencies in examples ([#709](https://github.com/nuxt-modules/storybook/pull/709))
- Update renovate config to not ignore 'examples' directories ([#711](https://github.com/nuxt-modules/storybook/pull/711))
- Remove unused nightly release from CI ([#719](https://github.com/nuxt-modules/storybook/pull/719))
- Fix devtools in playground ([#727](https://github.com/nuxt-modules/storybook/pull/727))
- Add e2e tests ([#729](https://github.com/nuxt-modules/storybook/pull/729))
- Fix typescript error ([#734](https://github.com/nuxt-modules/storybook/pull/734))
- Try to fix nightly release ([#735](https://github.com/nuxt-modules/storybook/pull/735))
- Try to publish nightly versions for all packages ([#736](https://github.com/nuxt-modules/storybook/pull/736))
- **vscode:** Remove `eslint.experimental.useFlatConfig` ([#730](https://github.com/nuxt-modules/storybook/pull/730))
- Improve PR template ([#737](https://github.com/nuxt-modules/storybook/pull/737))
- Set compatibilityDate in nuxt.config.ts files ([#738](https://github.com/nuxt-modules/storybook/pull/738))
- Increase version before publishing nightly ([#745](https://github.com/nuxt-modules/storybook/pull/745))
- Update fetch-depth in CI workflow to fix nightly release ([#747](https://github.com/nuxt-modules/storybook/pull/747))
- Add chromatic as sponsor ([e8837c4](https://github.com/nuxt-modules/storybook/commit/e8837c4))

### ❤️ Contributors

- Tobias Diez <code@tobiasdiez.de>
- Hugo Torzuoli ([@HZooly](http://github.com/HZooly))
- Olga Bulat ([@obulat](http://github.com/obulat))
- Gangan ([@shinGangan](http://github.com/shinGangan))

## v8.1.5

[compare changes](https://github.com/nuxt-modules/storybook/compare/v8.1.4...v8.1.5)
Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,9 @@ This repository is licensed under the [MIT License](LICENSE). Feel free to use t
💬 Discord: ChakAs3

🐦‍⬛ Twitter: [@ChakirQatab](https://twitter.com/ChakirQatab)

## Sponsors

<a href="https://www.chromatic.com/"><img src="https://user-images.githubusercontent.com/321738/84662277-e3db4f80-af1b-11ea-88f5-91d67a5e59f6.png" width="153" height="30" alt="Chromatic" /></a>

Thanks to [Chromatic](https://www.chromatic.com/) for providing the visual testing platform that helps us review UI changes and catch visual regressions.
Loading

0 comments on commit d358e3c

Please sign in to comment.