diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml index 0236ebf8..56a70070 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -1,23 +1,32 @@ name: ๐Ÿž Bug report description: Create a bug report for this project -labels: [bug] +labels: [bug, pending] body: - type: markdown attributes: value: | - Please help us finding and resolving problems. + Please carefully read the nuxt contribution docs before creating a bug report + ๐Ÿ‘‰ https://nuxt.com/docs/community/reporting-bugs + + Please use a template below to create a minimal reproduction + ๐Ÿ‘‰ https://stackblitz.com/github/nuxt/starter/tree/v3 + ๐Ÿ‘‰ https://codesandbox.io/s/github/nuxt/starter/tree/v3 - 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: textarea id: reproduction attributes: label: Reproduction - description: Provide a link to a repo that can reproduce the problem you ran into if you can. + description: Please provide a link to a repo that can reproduce the problem you ran into. A [**minimal reproduction**](https://nuxt.com/docs/community/reporting-bugs#create-a-minimal-reproduction) is required unless you are absolutely sure that the issue is obvious and the provided information is enough to understand the problem. If a report is vague (e.g. just a generic error message) and has no reproduction, it will receive a "need reproduction" label. If no reproduction is provided we might close it. placeholder: Reproduction + validations: + required: true - type: textarea id: bug-description attributes: @@ -37,4 +46,4 @@ body: label: Logs description: | Optional if provided reproduction. Please try not to insert an image but copy paste the log text. - render: shell + render: shell-script diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 7f137cd5..779fb139 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,8 +1,8 @@ -blank_issues_enabled: true +blank_issues_enabled: false contact_links: - - name: ๐Ÿ“š nuxt-auth documentation + - name: ๐Ÿ“š Documentation url: https://sidebase.io/nuxt-auth - about: Check the documentation for usage of nuxt-auth - - name: ๐Ÿ’ฌ Discussions - url: https://github.com/sidebase/nuxt-auth/discussions - about: Use discussions if you have another issue, an idea for improvement or for asking questions. + about: Check the documentation for usage of nuxt-auth! + - name: โญ Other projects + url: https://sidebase.io + about: Supercharge your Nuxt application with more of our projects! diff --git a/.github/ISSUE_TEMPLATE/enchantment.yml b/.github/ISSUE_TEMPLATE/enchantment.yml new file mode 100644 index 00000000..515c6647 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enchantment.yml @@ -0,0 +1,49 @@ +name: "๐Ÿš€ Enchantment" +description: Suggest an enchantment that will improve NuxtAuth +labels: ["pending", "enchantment"] +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to fill out this feature request! + + Please note: Only post enchanments that you have properly considered. This means: + - You have properly determined what problem your enchanment fixes + - How you would recommend implementing your enchancement + - How this change would impact NuxtAuth + + If you are still unsure about your implementation or would like to discuss it prior, open a discussion first: + ๐Ÿ‘‰ https://github.com/sidebase/nuxt-auth/discussions/new?category=feature-requests + - type: textarea + id: feature-description + attributes: + label: Describe the feature + description: A clear and concise description of what you think would be a helpful addition to NuxtAuth, including the possible use cases and alternatives you have considered. + placeholder: Feature description + validations: + required: true + - type: textarea + id: feature-implementation + attributes: + label: How would you implement this? + description: For this, please outline how this feature would work. This could be in the form of a textual description, or a walkthrough of what would be adjusted inside the code. + placeholder: Feature description + validations: + required: true + - type: checkboxes + id: additional-info + attributes: + label: Additional information + description: Additional information that helps us decide how to proceed. + options: + - label: Would you be willing to help implement this feature? + - type: checkboxes + id: provider-selection + attributes: + label: Provider + description: Please check the provider this feature targets. + options: + - label: AuthJS + - label: Local + - label: Refresh + - label: New Provider diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml deleted file mode 100644 index 6e196c0e..00000000 --- a/.github/ISSUE_TEMPLATE/feature-request.yaml +++ /dev/null @@ -1,22 +0,0 @@ -name: ๐Ÿš€ Feature request -description: Suggest a feature to improve this project -labels: [enhancement] -body: - - type: markdown - attributes: - value: | - Thank you for taking the time to fill out this feature request of this young, just growing project. It really means a lot to us! โค๏ธ - - type: textarea - id: feature-description - attributes: - label: Describe the feature - description: A clear and concise description of what you think would be a helpful addition, including the possible use cases and alternatives you have considered. If you have a working prototype or module that implements it, please include a link. - placeholder: Feature description - validations: - required: true - - type: textarea - id: additional-info - attributes: - label: Additional information - description: Additional information that helps us decide how to proceed. - placeholder: Additional information diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..ef48f7e7 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,27 @@ + + +### ๐Ÿ”— Linked issue + + + +### โ“ Type of change + + + +- [ ] ๐Ÿ“– Documentation (updates to the documentation, readme or JSdoc annotations) +- [ ] ๐Ÿž Bug fix (a non-breaking change that fixes an issue) +- [ ] ๐Ÿ‘Œ Enhancement (improving an existing functionality like performance) +- [ ] โœจ 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 + + +### ๐Ÿ“ Checklist + +- [ ] I have linked an issue or discussion. +- [ ] I have added tests (if possible). +- [ ] I have updated the documentation accordingly. diff --git a/.github/reproduire/needs-reproduction.md b/.github/reproduire/needs-reproduction.md new file mode 100644 index 00000000..1b794148 --- /dev/null +++ b/.github/reproduire/needs-reproduction.md @@ -0,0 +1,19 @@ +Hello ๐Ÿ‘‹ + +Please provide a [reproduction](https://nuxt.com/docs/community/reporting-bugs/#create-a-minimal-reproduction) for this issue ๐Ÿ™ + +
+How can I create a reproduction? + +Please use one of the following links to reproduce your issue. + +- https://stackblitz.com/github/nuxt/starter/tree/v3-stackblitz +- https://codesandbox.io/s/github/nuxt/starter/v3-codesandbox + +Please ensure that the reproduction is as **minimal** as possible. This will allow us to isolate the issue as best as possible. + +Here are some more amazing posts about the importance of reproductions: +- [The Importance of Reproductions](https://antfu.me/posts/why-reproductions-are-required) +- [How to Generate a Minimal, Complete, and Verifiable Example](https://stackoverflow.com/help/minimal-reproducible-example) + +
diff --git a/.github/workflows/reproduire-close.yml b/.github/workflows/reproduire-close.yml new file mode 100644 index 00000000..d5990961 --- /dev/null +++ b/.github/workflows/reproduire-close.yml @@ -0,0 +1,24 @@ +name: Close incomplete issues +on: + workflow_dispatch: + schedule: + - cron: '30 1 * * *' # run every day + +permissions: + issues: write + +jobs: + stale: + runs-on: ubuntu-latest + steps: + - uses: actions/stale@v9 + with: + days-before-stale: -1 # Issues and PR will never be flagged stale automatically. + stale-issue-label: 'needs reproduction' # Label that flags an issue as stale. + only-labels: 'needs reproduction' # Only process these issues + days-before-issue-close: 14 + ignore-updates: true + remove-stale-when-updated: false + close-issue-message: This issue was closed because it was open for 14 days without a reproduction. + close-issue-label: closed-by-bot + operations-per-run: 300 #default 30 diff --git a/.github/workflows/reproduire.yml b/.github/workflows/reproduire.yml new file mode 100644 index 00000000..77f95c28 --- /dev/null +++ b/.github/workflows/reproduire.yml @@ -0,0 +1,16 @@ +name: Reproduire +on: + issues: + types: [labeled] + +permissions: + issues: write + +jobs: + reproduire: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: Hebilicious/reproduire@4b686ae9cbb72dad60f001d278b6e3b2ce40a9ac # v0.0.9-mp + with: + label: needs-reproduction diff --git a/docs/content/1.getting-started/3.quick-start.md b/docs/content/1.getting-started/3.quick-start.md index b892d9cd..91c210a6 100644 --- a/docs/content/1.getting-started/3.quick-start.md +++ b/docs/content/1.getting-started/3.quick-start.md @@ -95,7 +95,7 @@ The backend must accept a request with a body like: and return a token that can be used to authenticate future requests in the response body, e.g., like: ```ts { - tokens: { + token: { accessToken: 'eyBlaBlub' } } @@ -142,7 +142,7 @@ The backend must accept a request with a body like: and return a token that can be used to authenticate future requests in the response body, e.g., like: ```ts { - tokens: { + token: { accessToken: 'eyBlaBlub' refreshToken: 'eyBlaubwww' }