Skip to content

Commit

Permalink
Merge branch 'main' into option-to-tokens-cookie-name
Browse files Browse the repository at this point in the history
  • Loading branch information
zoey-kaiser authored Feb 24, 2024
2 parents a23f0ce + e036b0b commit 4626ed5
Show file tree
Hide file tree
Showing 9 changed files with 156 additions and 34 deletions.
17 changes: 13 additions & 4 deletions .github/ISSUE_TEMPLATE/bug-report.yaml
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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
12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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!
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/enchantment.yml
Original file line number Diff line number Diff line change
@@ -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
22 changes: 0 additions & 22 deletions .github/ISSUE_TEMPLATE/feature-request.yaml

This file was deleted.

27 changes: 27 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<!---
☝️ PR title should follow conventional commits (https://conventionalcommits.org)
-->

### 🔗 Linked issue

<!-- Please ensure there is an open issue and mention its number as #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, 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.
19 changes: 19 additions & 0 deletions .github/reproduire/needs-reproduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Hello 👋

Please provide a [reproduction](https://nuxt.com/docs/community/reporting-bugs/#create-a-minimal-reproduction) for this issue 🙏

<details>
<summary>How can I create a reproduction?</summary>

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)

</details>
24 changes: 24 additions & 0 deletions .github/workflows/reproduire-close.yml
Original file line number Diff line number Diff line change
@@ -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
16 changes: 16 additions & 0 deletions .github/workflows/reproduire.yml
Original file line number Diff line number Diff line change
@@ -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
4 changes: 2 additions & 2 deletions docs/content/1.getting-started/3.quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -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'
}
}
Expand Down Expand Up @@ -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'
}
Expand Down

0 comments on commit 4626ed5

Please sign in to comment.