Release: Patch 7.1.1

.github/ISSUE_TEMPLATE/feature_request.yml → .github/DISCUSSION_TEMPLATE/ideas.yml

@@ -1,14 +1,11 @@
-name: Feature request 💡
-description: Suggest an idea for this project
-title: '[Feature Request]:'
 labels:
   - needs triage
   - feature request
 body:
   - type: textarea
     id: problem
     attributes:
-      label: Is your feature request related to a problem? Please describe
+      label: Is your feature request related to a problem? Please describe.
       description: >-
         A clear and concise description of the problem. E.g. I'm always
         frustrated when [...]

.github/DISCUSSION_TEMPLATE/rfc.yml

@@ -0,0 +1,104 @@
+title: '[RFC] '
+labels: ['RFC']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        # Request For Comments
+        Welcome! 👋
+
+        If you are interested in proposing a new feature or improvement to Storybook, then you are in the right place! 
+        This template is designed to help users and contributors propose a solution to a problem, receive feedback, and finally gain alignment.
+        Thank you for taking the time to improve Storybook.
+  - type: textarea
+    id: summary
+    attributes:
+      label: Summary
+      description: |
+        A brief, 1-5 sentences explanation of the RFC.
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: |
+        ## The Problem
+  - type: textarea
+    id: problem-statement
+    attributes:
+      label: Problem Statement
+      description: |
+        A few sentences or bullets summarizing the problem we are trying to solve. Non-core members should be able to read this and understand why we are doing this.
+      placeholder: |
+        Doing X is hard because combining Y and Z makes Storybook go 💥...
+    validations:
+      required: true
+  - type: textarea
+    id: non-goals
+    attributes:
+      label: Non-goals
+      description: |
+        Key bullets explicitly outlining what is not in-scope.
+      placeholder: |
+        Making Y work with W is not part of this proposal because...
+  - type: markdown
+    attributes:
+      value: |
+        ## 🚀 Proposed Solution
+        Here is where you can get technical!
+        The goal of this section is to outline the technical changes necessary for the proposed solution.
+        In most cases, the content of this section will evolve as discussions take place.
+  - type: textarea
+    id: implementation
+    attributes:
+      label: Implementation
+      description: |
+        What are the high level technical (architecture, data structure, UI, etc) changes? Diagrams can be very helpful here.
+      placeholder: |
+        I propose a new API for integrating Y with Z to achieve X. The API will be...
+    validations:
+      required: true
+  - type: textarea
+    id: prior-art
+    attributes:
+      label: Prior Art
+      description: |
+        Has this been done before, maybe in the broader ecosystem?
+      placeholder: |
+        Project A has done something similar for a long time, and the B addon supports this by...
+  - type: textarea
+    id: deliverables
+    attributes:
+      label: Deliverables
+      description: |
+        List out the high-level deliverables that make up this body of work.
+        Each deliverable should be small enough to be reliably estimable but large enough to represent a meaningful delivery, usually one cycle (2 weeks) worth of work.
+      placeholder: |
+        1. Restructure Y to support incoming Z
+        2. Integrate Z into Y
+        3. Build V on top of Y and Z
+  - type: textarea
+    id: risks
+    attributes:
+      label: Risks
+      description: |
+        What risks might be introduced by this set of changes? How can we mitigate these risks?
+      placeholder: |
+        - This will make it harder to use X in this scenario because...
+  - type: textarea
+    id: unresolved-questions
+    attributes:
+      label: Unresolved Questions
+      description: |
+        Questions we hope to answer as part of this proposal review process.
+      value: |
+        - [ ] Using a to do list makes it easy to resolve the questions as we move the RFC along.
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives considered / Abandoned Ideas
+      description: |
+        Describe alternative approaches that have been considered and why they have been dropped.
+
+        As we discuss this project, it is common for some ideas to be abandoned. Instead of deleting them, let's document the rationale. This way, when people review this proposal in the future, they can avoid the same thinking path and pitfalls we have already learned from.
+      placeholder: |
+        I've considered combining U and I, but that is a worse solution because...

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -24,8 +24,7 @@ body:
         [documentation](https://storybook.js.org/docs/react/contribute/how-to-reproduce)
         to learn more about creating reproductions.
       placeholder: >-
-        Paste your repository and deployed reproduction here. We prioritize
-        issues with reproductions over those without.
+        Paste a link to your reproduction here. We prioritize issues with reproductions over those without.
   - type: textarea
     id: system
     attributes:

.github/ISSUE_TEMPLATE/config.yml

@@ -2,10 +2,16 @@ blank_issues_enabled: false
 contact_links:
   - name: View documentation 📚
     url: https://storybook.js.org/docs/
-    about: Check out the official docs for answers to common questions
+    about: Check out the official docs for answers to common questions.
+  - name: Feature Requests 💡
+    url: https://github.com/storybookjs/storybook/discussions/new?category=ideas
+    about: Suggest a feature idea for this project.
+  - name: Open an RFC 🦄
+    url: https://github.com/storybookjs/storybook/discussions/new?category=rfc
+    about: Do you want to propose a more involved change to Storybook? Open an RFC (Request for Comments) to start a discussion.
   - name: Questions & discussions 🤔
     url: https://github.com/storybookjs/storybook/discussions
-    about: Ask questions, request features & discuss RFCs
+    about: Ask questions, show off your Storybook, etc. 
   - name: Community Discord 💬
     url: https://discord.gg/storybook
     about: Community discussions, interactive support, contributor help

.github/PULL_REQUEST_TEMPLATE.md

@@ -27,11 +27,10 @@ Closes #
 
 #### Maintainers
 
-- [ ] If this PR should be tested against many or all sandboxes,
-      make sure to add the `ci:merged` or `ci:daily` GH label to it.
+- [ ] When this PR is ready for testing, make sure to add `ci:normal`, `ci:merged` or `ci:daily` GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in `code/lib/cli/src/sandbox-templates.ts`
 - [ ] Make sure this PR contains **one** of the labels below.
 
-`["cleanup", "BREAKING CHANGE", "feature request", "bug", "documentation", "maintenance", "dependencies", "other"]`
+`["cleanup", "BREAKING CHANGE", "feature request", "bug", "build", "documentation", "maintenance", "dependencies", "other"]`
 
 <!--
 

.github/workflows/publish.yml

@@ -27,6 +27,15 @@ jobs:
       run:
         working-directory: scripts
     steps:
+      - name: Cancel if [skip ci]
+        if: contains(github.event.head_commit.message, '[skip ci]')
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        # From https://stackoverflow.com/a/75809743
+        run: |
+          gh run cancel ${{ github.run_id }}
+          gh run watch ${{ github.run_id }}
+
       - name: Checkout ${{ github.ref_name }}
         uses: actions/checkout@v3
         with:
@@ -71,7 +80,7 @@ jobs:
           git config --global user.name "storybook-bot"
           git config --global user.email "32066757+storybook-bot@users.noreply.github.com"
           git add .
-          git commit -m "Bump version from $CURRENT_VERSION to $DEFERRED_NEXT_VERSION" || true
+          git commit -m "Bump version from $CURRENT_VERSION to $DEFERRED_NEXT_VERSION [skip ci]" || true
           git push origin ${{ github.ref_name }}
 
       - name: Get current version
@@ -112,11 +121,13 @@ jobs:
         if: github.ref_name == 'latest-release'
         run: git fetch --tags origin
 
+      # when this is a patch release from main, label any patch PRs included in the release
+      # when this is a stable release from next, label ALL patch PRs found, as they will per definition be "patched" now
       - name: Label patch PRs as picked
-        if: github.ref_name == 'latest-release'
+        if: github.ref_name == 'latest-release' || (steps.publish-needed.outputs.published == 'false' && steps.target.outputs.target == 'next' && !steps.is-prerelease.outputs.prerelease)
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: yarn release:label-patches
+        run: yarn release:label-patches ${{ steps.target.outputs.target == 'next' && '--all' || '' }}
 
       - name: Create GitHub Release
         if: steps.publish-needed.outputs.published == 'false'
@@ -149,28 +160,46 @@ jobs:
           git pull
           git checkout origin/main ./CHANGELOG.md
           git add ./CHANGELOG.md
-          git commit -m "Update CHANGELOG.md for v${{ steps.version.outputs.current-version }}"
+          git commit -m "Update CHANGELOG.md for v${{ steps.version.outputs.current-version }} [skip ci]"
           git push origin next
 
-      - name: Sync versions/next.json from `next` to `main`
+      - name: Sync version JSONs from `next-release` to `main`
         if: github.ref_name == 'next-release'
         working-directory: .
         run: |
+          VERSION_FILE="./docs/versions/${{ steps.is-prerelease.outputs.prerelease == 'true' && 'next' || 'latest' }}.json"
           git fetch origin main
           git checkout main
           git pull
-          git checkout origin/next ./docs/versions/next.json
-          git add ./docs/versions/next.json
-          git commit -m "Update versions/next.json for v${{ steps.version.outputs.current-version }}"
+          git checkout origin/next-release $VERSION_FILE
+          git add $VERSION_FILE
+          git commit -m "Update $VERSION_FILE for v${{ steps.version.outputs.current-version }}"
           git push origin main
 
-      # Force push from next to main if it is not a prerelease, and this release is from next-release
+      # TODO: this is currently disabled, because we may have a better strategy that we want to try out manually first before comitting to it:
+      #     - create a branch "release-<VERSION>" from HEAD of main
+      #     - git push --force origin ${{ steps.target.outputs.target }}:main
+      #     - ... this will keep the "main" history in the new release branch, and then overwrite main's history with next's
+
+      # Sync next-release to main if it is not a prerelease, and this release is from next-release
       # This happens when eg. next has been tracking 7.1.0-alpha.X, and now we want to release 7.1.0
-      # This will keep release-next, next and main all tracking v7.1.0
-      # - name: Force push ${{ steps.target.outputs.target }} to main
+      # This will keep next-release, next and main all tracking v7.1.0
+      # See "Alternative merge strategies" in https://stackoverflow.com/a/36321787
+      # - name: Sync next-release to main
       #   if: steps.publish-needed.outputs.published == 'false' && steps.target.outputs.target == 'next' && !steps.is-prerelease.outputs.prerelease
+      #   working-directory: .
       #   run: |
-      #     git push --force origin ${{ steps.target.outputs.target }}:main
+      #     git fetch origin next-release
+      #     git checkout next-release
+      #     git pull
+      #     git fetch origin main
+      #     git checkout main
+      #     git pull
+      #     git merge --no-commit -s ours next-release
+      #     git rm -rf .
+      #     git checkout next-release -- .
+      #     git commit -m "Sync next-release to main"
+      #     git push origin main
 
       - name: Report job failure to Discord
         if: failure()

.github/workflows/trigger-circle-ci-workflow.yml

@@ -10,6 +10,10 @@ on:
       - next
       - main
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   get-branch:
     runs-on: ubuntu-latest
@@ -32,39 +36,20 @@ jobs:
     outputs:
       branch: ${{ env.branch }}
 
-  trigger-ci-tests:
-    runs-on: ubuntu-latest
-    needs: get-branch
-    if: github.event_name == 'pull_request_target' && github.event.pull_request.draft == true && !contains(github.event.pull_request.labels.*.name, 'ci:pr') && !contains(github.event.pull_request.labels.*.name, 'ci:merged') && !contains(github.event.pull_request.labels.*.name, 'ci:daily')
-    steps:
-      - name: Trigger draft PR tests
-        run: >
-          curl -X POST --location "https://circleci.com/api/v2/project/gh/storybookjs/storybook/pipeline" \
-            -H "Content-Type: application/json" \
-            -H "Circle-Token: $CIRCLE_CI_TOKEN" \
-            -d '{
-                  "branch": "'"$BRANCH"'",
-                  "parameters": {
-                    "workflow": "ci"
-                  }
-                }'
-        env:
-          CIRCLE_CI_TOKEN: ${{ secrets.CIRCLE_CI_TOKEN }}
-          BRANCH: ${{ needs.get-branch.outputs.branch }}
-  trigger-pr-tests:
+  trigger-normal-tests:
     runs-on: ubuntu-latest
     needs: get-branch
-    if: github.event_name == 'pull_request_target' && (((github.event.pull_request.draft == false && !contains(github.event.pull_request.labels.*.name, 'release')) || contains(github.event.pull_request.labels.*.name, 'ci:pr')) && !contains(github.event.pull_request.labels.*.name, 'ci:merged') && !contains(github.event.pull_request.labels.*.name, 'ci:daily'))
+    if: github.event_name == 'pull_request_target' && contains(github.event.pull_request.labels.*.name, 'ci:normal')
     steps:
-      - name: Trigger PR tests
+      - name: Trigger Normal tests
         run: >
           curl -X POST --location "https://circleci.com/api/v2/project/gh/storybookjs/storybook/pipeline" \
             -H "Content-Type: application/json" \
             -H "Circle-Token: $CIRCLE_CI_TOKEN" \
             -d '{
                   "branch": "'"$BRANCH"'",
                   "parameters": {
-                    "workflow": "pr"
+                    "workflow": "normal"
                   }
                 }'
         env:
@@ -73,7 +58,7 @@ jobs:
   trigger-merged-tests:
     runs-on: ubuntu-latest
     needs: get-branch
-    if: github.event_name == 'push' || (contains(github.event.pull_request.labels.*.name, 'ci:merged') && !contains(github.event.pull_request.labels.*.name, 'ci:daily'))
+    if: github.event_name == 'push' || contains(github.event.pull_request.labels.*.name, 'ci:merged')
     steps:
       - name: Trigger merged tests
         run: >

.gitignore

@@ -49,3 +49,4 @@ code/test-results/
 code/playwright-results/
 code/playwright-report/
 code/playwright/.cache/
+code/bench-results/

.vscode/settings.json

@@ -51,5 +51,6 @@
     "*.js": "javascriptreact"
   },
   "prettier.ignorePath": "./code/.prettierignore",
-  "typescript.tsdk": "./code/node_modules/typescript/lib"
+  "typescript.tsdk": "./code/node_modules/typescript/lib",
+  "storyExplorer.storybookConfigDir": "./code/ui/.storybook"
 }