chore: merge pull request #67 from Questionable-Content-Extensions/release/1.0.0

Release version 1.0.0

Author: ilyvion

.babelrc

@@ -1,3 +1,6 @@
 node_modules
-npm-debug.log
+storybook-static
+build
 dist
+Dockerfile
+.dockerignore

.dockerignore

@@ -0,0 +1,32 @@
+{
+    "extends": ["react-app"],
+    "ignorePatterns": [
+        "dist/**",
+        "build/**",
+        "storybook-static/**",
+        "!.storybook"
+    ],
+    "rules": {
+        "no-unused-vars": "off"
+    },
+    "overrides": [
+        {
+            "files": ["**/*.ts?(x)"],
+            "rules": {
+                "@typescript-eslint/no-unused-vars": [
+                    "warn",
+                    {
+                        "argsIgnorePattern": "^_",
+                        "varsIgnorePattern": "^_"
+                    }
+                ]
+            }
+        },
+        {
+            "files": ["**/*.stories.*"],
+            "rules": {
+                "import/no-anonymous-default-export": "off"
+            }
+        }
+    ]
+}

.eslintrc.js

@@ -0,0 +1,13 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: ilyvion # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.eslintrc.json

@@ -0,0 +1,46 @@
+name: CI
+
+on:
+    push:
+        branches: [develop]
+    pull_request:
+        branches: [develop]
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v3
+
+            - name: Use Node.js 18.x
+              uses: actions/setup-node@v3
+              with:
+                  node-version: 18.x
+                  cache: 'npm'
+
+            - name: Install Node modules
+              run: npm ci
+
+            - name: Run ESLint
+              run: npx eslint .
+
+            # Tests are currently kind of broken. Leave it for another day.
+
+            #- name: Run tests
+            #  run: npm test
+
+            # - name: Install Playwright
+            #   run: npx playwright install --with-deps
+
+            # - name: Build Storybook
+            #   run: npm run build-storybook
+
+            # - name: Run Storybook tests
+            #   run: |
+            #       npx concurrently -k -s last -n "SB,TEST" -c "magenta,blue" \
+            #       "npx http-server storybook-static --port 6006 --silent" \
+            #       "npx wait-on http://127.0.0.1:6006/ && npm run test-storybook"
+
+            - name: Ensure everything builds
+              run: npm run build

.flowconfig

@@ -0,0 +1,62 @@
+name: 'Draft new release'
+
+on:
+    workflow_dispatch:
+        inputs:
+            version:
+                description: 'The version you want to release.'
+                required: true
+
+jobs:
+    draft-new-release:
+        name: 'Draft a new release'
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+
+            - name: Create release branch
+              run: git checkout -b release/${{ github.event.inputs.version }}
+
+            - name: Update changelog
+              uses: thomaseizinger/keep-a-changelog-new-release@1.1.0
+              with:
+                  version: ${{ github.event.inputs.version }}
+
+            # In order to make a commit, we need to initialize a user.
+            - name: Initialize mandatory git config
+              run: |
+                  git config user.name "GitHub Actions"
+                  git config user.email noreply@github.com
+
+            # This step will differ depending on your project setup
+            # Fortunately, yarn has a built-in command for doing this!
+            - name: Bump version in package.json
+              run: npm version ${{ github.event.inputs.version }} --no-git-tag-version
+
+            - name: Commit changelog and manifest files
+              id: make-commit
+              run: |
+                  git add CHANGELOG.md package.json
+                  git commit --message "chore: prepare release ${{ github.event.inputs.version }}"
+
+                  echo "::set-output name=commit::$(git rev-parse HEAD)"
+
+            - name: Push new branch
+              run: git push origin release/${{ github.event.inputs.version }}
+
+            - name: Create pull request
+              uses: thomaseizinger/create-pull-request@1.0.0
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+              with:
+                  head: release/${{ github.event.inputs.version }}
+                  base: main
+                  title: Release version ${{ github.event.inputs.version }}
+                  reviewers: ${{ github.actor }}
+                  body: |
+                      Hi @${{ github.actor }}!
+
+                      This PR was created in response to a manual trigger of the release workflow here: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}.
+                      I've updated the changelog and bumped the versions in the manifest files in this commit: ${{ steps.make-commit.outputs.commit }}.
+
+                      Merging this PR will create a GitHub release and upload any assets that are created as part of the release build.

.github/FUNDING.yml

@@ -0,0 +1,78 @@
+name: 'Publish new release'
+
+on:
+    pull_request:
+        branches:
+            - main
+        types:
+            - closed
+
+jobs:
+    release:
+        name: Publish new release
+        runs-on: ubuntu-latest
+        # only merged pull requests that begin with 'release/' or 'hotfix/' must trigger this job
+        if: github.event.pull_request.merged == true &&
+            (startsWith(github.event.pull_request.head.ref, 'release/') || startsWith(github.event.pull_request.head.ref, 'hotfix/'))
+
+        steps:
+            - name: Extract version from branch name (for release branches)
+              if: startsWith(github.event.pull_request.head.ref, 'release/')
+              run: |
+                  BRANCH_NAME="${{ github.event.pull_request.head.ref }}"
+                  VERSION=${BRANCH_NAME#release/}
+
+                  echo "RELEASE_VERSION=$VERSION" >> $GITHUB_ENV
+
+            - name: Extract version from branch name (for hotfix branches)
+              if: startsWith(github.event.pull_request.head.ref, 'hotfix/')
+              run: |
+                  BRANCH_NAME="${{ github.event.pull_request.head.ref }}"
+                  VERSION=${BRANCH_NAME#hotfix/}
+
+                  echo "RELEASE_VERSION=$VERSION" >> $GITHUB_ENV
+
+            - uses: actions/checkout@v3
+
+            - name: Use Node.js 18.x
+              uses: actions/setup-node@v3
+              with:
+                  node-version: 18.x
+                  cache: 'npm'
+
+            - name: Install Node modules
+              run: npm ci
+
+            - name: Build scripts
+              run: npm run build-userscript
+
+            - name: Extract release notes
+              id: extract-release-notes
+              uses: ffurrer2/extract-release-notes@v1
+              with:
+                  changelog_file: CHANGELOG.md
+
+            - name: Release
+              uses: softprops/action-gh-release@v1
+              with:
+                  target_commitish: ${{ github.event.pull_request.merge_commit_sha }}
+                  tag_name: ${{ env.RELEASE_VERSION }}
+                  name: ${{ env.RELEASE_VERSION }}
+                  draft: false
+                  prerelease: false
+                  body: ${{ steps.extract-release-notes.outputs.release_notes }}
+                  files: |
+                      ./dist/qc-ext.user.js
+                      ./dist/qc-ext.meta.js
+
+            - name: Merge main into dev branch
+              uses: thomaseizinger/create-pull-request@1.0.0
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+              with:
+                  head: main
+                  base: develop
+                  title: Merge main into develop branch
+                  body: |
+                      This PR merges the main branch back into develop.
+                      This happens to ensure that the updates that happend on the release branch, i.e. CHANGELOG and manifest updates are also present on the dev branch.

.github/workflows/CI.yml

@@ -1,9 +1,30 @@
-/.sass-cache
-/assets/generated
-/assets/removeFlow
-/dist
-/nbproject/private
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
 /node_modules
-/.vagrant
-/.tmp
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# deployment
+/dist
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
 
+# storybook
+/src/stories
+/storybook-static