From 302683d4747a5298d39fdcb9605b5dabc33efc31 Mon Sep 17 00:00:00 2001 From: frederikprijck Date: Tue, 12 Sep 2023 11:30:11 +0200 Subject: [PATCH] Update references from master to main branch --- .github/ISSUE_TEMPLATE/Bug Report.yml | 2 +- .github/ISSUE_TEMPLATE/Feature Request.yml | 2 +- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/workflows/browserstack.yml | 4 ++-- .github/workflows/codeql.yml | 4 ++-- .github/workflows/integration.yml | 6 +++--- .github/workflows/publish.yml | 2 +- .github/workflows/semgrep.yml | 4 ++-- .github/workflows/snyk.yml | 4 ++-- .github/workflows/test.yml | 6 +++--- EXAMPLES.md | 2 +- FAQ.md | 2 +- README.md | 14 +++++++------- TROUBLESHOOTING.md | 2 +- docs/index.html | 14 +++++++------- 15 files changed, 35 insertions(+), 35 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/Bug Report.yml b/.github/ISSUE_TEMPLATE/Bug Report.yml index 175d3051..936e9757 100644 --- a/.github/ISSUE_TEMPLATE/Bug Report.yml +++ b/.github/ISSUE_TEMPLATE/Bug Report.yml @@ -15,7 +15,7 @@ body: options: - label: The issue can be reproduced in the [auth0-react sample app](https://github.com/auth0-samples/auth0-react-samples/tree/master/Sample-01) (or N/A). required: true - - label: I have looked into the [Readme](https://github.com/auth0/auth0-react#readme), [Examples](https://github.com/auth0/auth0-react/blob/master/EXAMPLES.md), and [FAQ](https://github.com/auth0/auth0-react/blob/master/FAQ.md) and have not found a suitable solution or answer. + - label: I have looked into the [Readme](https://github.com/auth0/auth0-react#readme), [Examples](https://github.com/auth0/auth0-react/blob/main/EXAMPLES.md), and [FAQ](https://github.com/auth0/auth0-react/blob/main/FAQ.md) and have not found a suitable solution or answer. required: true - label: I have looked into the [API documentation](https://auth0.github.io/auth0-react/) and have not found a suitable solution or answer. required: true diff --git a/.github/ISSUE_TEMPLATE/Feature Request.yml b/.github/ISSUE_TEMPLATE/Feature Request.yml index 178dc382..86461730 100644 --- a/.github/ISSUE_TEMPLATE/Feature Request.yml +++ b/.github/ISSUE_TEMPLATE/Feature Request.yml @@ -8,7 +8,7 @@ body: attributes: label: Checklist options: - - label: I have looked into the [Readme](https://github.com/auth0/auth0-react#readme), [Examples](https://github.com/auth0/auth0-react/blob/master/EXAMPLES.md), and [FAQ](https://github.com/auth0/auth0-react/blob/master/FAQ.md) and have not found a suitable solution or answer. + - label: I have looked into the [Readme](https://github.com/auth0/auth0-react#readme), [Examples](https://github.com/auth0/auth0-react/blob/main/EXAMPLES.md), and [FAQ](https://github.com/auth0/auth0-react/blob/main/FAQ.md) and have not found a suitable solution or answer. required: true - label: I have looked into the [API documentation](https://auth0.github.io/auth0-react/) and have not found a suitable solution or answer. required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index de8eccdc..edd151ff 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -4,7 +4,7 @@ contact_links: url: https://community.auth0.com about: Discuss this SDK in the Auth0 Community forums - name: FAQ - url: https://github.com/auth0/auth0-react/blob/master/FAQ.md + url: https://github.com/auth0/auth0-react/blob/main/FAQ.md about: Read the FAQ to get answers to common issues - name: SDK API Documentation url: https://auth0.github.io/auth0-react/ diff --git a/.github/workflows/browserstack.yml b/.github/workflows/browserstack.yml index 19fe8b35..0bcf806d 100644 --- a/.github/workflows/browserstack.yml +++ b/.github/workflows/browserstack.yml @@ -9,14 +9,14 @@ on: - synchronize push: branches: - - master + - main permissions: contents: read concurrency: group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} - cancel-in-progress: ${{ github.ref != 'refs/heads/master' }} + cancel-in-progress: ${{ github.ref != 'refs/heads/main' }} env: NODE_VERSION: 18 diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index 2c700ac0..1264f1c6 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -8,7 +8,7 @@ on: - synchronize push: branches: - - master + - main - beta schedule: - cron: '37 10 * * 2' @@ -20,7 +20,7 @@ permissions: concurrency: group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} - cancel-in-progress: ${{ github.ref != 'refs/heads/master' }} + cancel-in-progress: ${{ github.ref != 'refs/heads/main' }} jobs: analyze: diff --git a/.github/workflows/integration.yml b/.github/workflows/integration.yml index c33b5b3c..3e240cad 100644 --- a/.github/workflows/integration.yml +++ b/.github/workflows/integration.yml @@ -5,17 +5,17 @@ on: workflow_dispatch: # pull_request: # branches: - # - master + # - main # push: # branches: - # - master + # - main permissions: contents: read concurrency: group: ${{ github.workflow }}-${{ github.ref }} - cancel-in-progress: ${{ github.ref != 'refs/heads/master' }} + cancel-in-progress: ${{ github.ref != 'refs/heads/main' }} env: NODE_VERSION: 18 diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 63ef1418..e910cdc0 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -6,7 +6,7 @@ on: branch: description: The branch to release from required: true - default: master + default: main version: description: The version being published. This should be a valid semver version, such as `1.0.0`. required: true diff --git a/.github/workflows/semgrep.yml b/.github/workflows/semgrep.yml index a08d4518..ea3fb0fe 100644 --- a/.github/workflows/semgrep.yml +++ b/.github/workflows/semgrep.yml @@ -8,7 +8,7 @@ on: - synchronize push: branches: - - master + - main - beta schedule: - cron: '30 0 1,15 * *' @@ -18,7 +18,7 @@ permissions: concurrency: group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} - cancel-in-progress: ${{ github.ref != 'refs/heads/master' }} + cancel-in-progress: ${{ github.ref != 'refs/heads/main' }} jobs: authorize: diff --git a/.github/workflows/snyk.yml b/.github/workflows/snyk.yml index 15b31773..45e13226 100644 --- a/.github/workflows/snyk.yml +++ b/.github/workflows/snyk.yml @@ -9,7 +9,7 @@ on: - synchronize push: branches: - - master + - main - beta schedule: - cron: '30 0 1,15 * *' @@ -19,7 +19,7 @@ permissions: concurrency: group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} - cancel-in-progress: ${{ github.ref != 'refs/heads/master' }} + cancel-in-progress: ${{ github.ref != 'refs/heads/main' }} jobs: authorize: diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index dc983a94..b70b057b 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -5,17 +5,17 @@ on: workflow_dispatch: pull_request: branches: - - master + - main push: branches: - - master + - main permissions: contents: read concurrency: group: ${{ github.workflow }}-${{ github.ref }} - cancel-in-progress: ${{ github.ref != 'refs/heads/master' }} + cancel-in-progress: ${{ github.ref != 'refs/heads/main' }} env: NODE_VERSION: 18 diff --git a/EXAMPLES.md b/EXAMPLES.md index ecd4793d..be368706 100644 --- a/EXAMPLES.md +++ b/EXAMPLES.md @@ -44,7 +44,7 @@ export default withAuthenticationRequired(PrivateRoute, { }); ``` -**Note** If you are using a custom router, you will need to supply the `Auth0Provider` with a custom `onRedirectCallback` method to perform the action that returns the user to the protected page. See examples for [react-router](https://github.com/auth0/auth0-react/blob/master/EXAMPLES.md#1-protecting-a-route-in-a-react-router-dom-app), [Gatsby](https://github.com/auth0/auth0-react/blob/master/EXAMPLES.md#2-protecting-a-route-in-a-gatsby-app) and [Next.js](https://github.com/auth0/auth0-react/blob/master/EXAMPLES.md#3-protecting-a-route-in-a-nextjs-app-in-spa-mode). +**Note** If you are using a custom router, you will need to supply the `Auth0Provider` with a custom `onRedirectCallback` method to perform the action that returns the user to the protected page. See examples for [react-router](https://github.com/auth0/auth0-react/blob/main/EXAMPLES.md#1-protecting-a-route-in-a-react-router-dom-app), [Gatsby](https://github.com/auth0/auth0-react/blob/main/EXAMPLES.md#2-protecting-a-route-in-a-gatsby-app) and [Next.js](https://github.com/auth0/auth0-react/blob/main/EXAMPLES.md#3-protecting-a-route-in-a-nextjs-app-in-spa-mode). ## Call an API diff --git a/FAQ.md b/FAQ.md index f7725e2f..6db02a8e 100644 --- a/FAQ.md +++ b/FAQ.md @@ -1,6 +1,6 @@ # Frequently Asked Questions -**Note:** `auth0-react` uses [Auth0 SPA JS](https://github.com/auth0/auth0-spa-js) behind the scenes, so be sure to check [their FAQs](https://github.com/auth0/auth0-spa-js/blob/master/FAQ.md) too. +**Note:** `auth0-react` uses [Auth0 SPA JS](https://github.com/auth0/auth0-spa-js) behind the scenes, so be sure to check [their FAQs](https://github.com/auth0/auth0-spa-js/blob/main/FAQ.md) too. 1. [User is not logged in after page refresh](#1-user-is-not-logged-in-after-page-refresh) 2. [User is not logged in after successful sign in with redirect](#2-user-is-not-logged-in-after-successful-sign-in-with-redirect) diff --git a/README.md b/README.md index 7dfbd460..069c5bc5 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ ![Auth0 SDK for React Single Page Applications](https://cdn.auth0.com/website/sdks/banners/auth0-react-banner.png) [![npm](https://img.shields.io/npm/v/@auth0/auth0-react.svg?style=flat)](https://www.npmjs.com/package/@auth0/auth0-react) -[![codecov](https://img.shields.io/codecov/c/github/auth0/auth0-react/master.svg?style=flat)](https://codecov.io/gh/auth0/auth0-react) +[![codecov](https://img.shields.io/codecov/c/github/auth0/auth0-react/main.svg?style=flat)](https://codecov.io/gh/auth0/auth0-react) ![Downloads](https://img.shields.io/npm/dw/@auth0/auth0-react) [![License](https://img.shields.io/:license-mit-blue.svg?style=flat)](https://opensource.org/licenses/MIT) -[![CircleCI](https://img.shields.io/circleci/build/github/auth0/auth0-react.svg?branch=master&style=flat)](https://circleci.com/gh/auth0/auth0-react) +[![CircleCI](https://img.shields.io/circleci/build/github/auth0/auth0-react.svg?branch=main&style=flat)](https://circleci.com/gh/auth0/auth0-react) 📚 [Documentation](#documentation) - 🚀 [Getting Started](#getting-started) - 💻 [API Reference](#api-reference) - 💬 [Feedback](#feedback) @@ -12,8 +12,8 @@ - [Quickstart](https://auth0.com/docs/quickstart/spa/react) - our interactive guide for quickly adding login, logout and user information to a React app using Auth0. - [Sample App](https://github.com/auth0-samples/auth0-react-samples/tree/master/Sample-01) - a full-fledged React application integrated with Auth0. -- [FAQs](https://github.com/auth0/auth0-react/blob/master/FAQ.md) - frequently asked questions about the auth0-react SDK. -- [Examples](https://github.com/auth0/auth0-react/blob/master/EXAMPLES.md) - code samples for common React authentication scenario's. +- [FAQs](https://github.com/auth0/auth0-react/blob/main/FAQ.md) - frequently asked questions about the auth0-react SDK. +- [Examples](https://github.com/auth0/auth0-react/blob/main/EXAMPLES.md) - code samples for common React authentication scenario's. - [Docs site](https://www.auth0.com/docs) - explore our docs site and learn more about Auth0. ## Getting started @@ -140,7 +140,7 @@ function App() { export default App; ``` -For more code samples on how to integrate **auth0-react** SDK in your **React** application, have a look at our [examples](https://github.com/auth0/auth0-react/blob/master/EXAMPLES.md). +For more code samples on how to integrate **auth0-react** SDK in your **React** application, have a look at our [examples](https://github.com/auth0/auth0-react/blob/main/EXAMPLES.md). ## API reference @@ -160,7 +160,7 @@ We appreciate feedback and contribution to this repo! Before you get started, pl - [Auth0's general contribution guidelines](https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md) - [Auth0's code of conduct guidelines](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md) -- [This repo's contribution guide](https://github.com/auth0/auth0-react/blob/master/CONTRIBUTING.md) +- [This repo's contribution guide](https://github.com/auth0/auth0-react/blob/main/CONTRIBUTING.md) ### Raise an issue @@ -181,4 +181,4 @@ Please do not report security vulnerabilities on the public GitHub issue tracker

Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout Why Auth0?

-This project is licensed under the MIT license. See the LICENSE file for more info.

+This project is licensed under the MIT license. See the LICENSE file for more info.

diff --git a/TROUBLESHOOTING.md b/TROUBLESHOOTING.md index 24815dd2..df4d9ace 100644 --- a/TROUBLESHOOTING.md +++ b/TROUBLESHOOTING.md @@ -5,6 +5,6 @@ When your application is not behaving as expected: - Check for any messages in the console - Check the Network Activity especially any requests to your authorization server - Check the log data in your [Auth0 Dashboard](https://manage.auth0.com#/logs) -- Check the `@auth0/auth0-spa-js` [FAQs](https://github.com/auth0/auth0-spa-js/blob/master/FAQ.md) +- Check the `@auth0/auth0-spa-js` [FAQs](https://github.com/auth0/auth0-spa-js/blob/main/FAQ.md) If you believe there is a bug in the SDK, [raise an issue](https://github.com/auth0/auth0-spa-js/issues/new/choose). Be sure to include all the information required to reproduce the issue. diff --git a/docs/index.html b/docs/index.html index 311baf23..63989cb8 100644 --- a/docs/index.html +++ b/docs/index.html @@ -14,10 +14,10 @@

@auth0/auth0-react

Auth0 SDK for React Single Page Applications

npm -codecov +codecov Downloads License -CircleCI

+CircleCI

📚 Documentation - 🚀 Getting Started - 💻 API Reference - 💬 Feedback

@@ -26,8 +26,8 @@

Documentation

 @@ -86,7 +86,7 @@

Configure the SDK

Use the useAuth0 hook in your components to access authentication state (isLoading, isAuthenticated and user) and authentication methods (loginWithRedirect and logout):

// src/App.js
import React from 'react';
import { useAuth0 } from '@auth0/auth0-react';

function App() {
  const { isLoading, isAuthenticated, error, user, loginWithRedirect, logout } =
    useAuth0();

  if (isLoading) {
    return <div>Loading...</div>;
  }
  if (error) {
    return <div>Oops... {error.message}</div>;
  }

  if (isAuthenticated) {
    return (
      <div>
        Hello {user.name}{' '}
        <button onClick={() => logout({ logoutParams: { returnTo: window.location.origin } })}>
          Log out
        </button>
      </div>
    );
  } else {
    return <button onClick={() => loginWithRedirect()}>Log in</button>;
  }
}

export default App;
-

For more code samples on how to integrate auth0-react SDK in your React application, have a look at our examples.

+

For more code samples on how to integrate auth0-react SDK in your React application, have a look at our examples.

API reference

@@ -111,7 +111,7 @@

Contributing

 @@ -133,7 +133,7 @@

Vulnerability Reporting

Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout Why Auth0?

-This project is licensed under the MIT license. See the LICENSE file for more info.

+This project is licensed under the MIT license. See the LICENSE file for more info.