diff --git a/.changeset/twenty-clocks-retire.md b/.changeset/twenty-clocks-retire.md new file mode 100644 index 0000000..ca6fa8b --- /dev/null +++ b/.changeset/twenty-clocks-retire.md @@ -0,0 +1,7 @@ +--- +'@asgardeo/remix-auth-asgardeo': patch +--- + +### v0.0.2 🎉 + +- Add README to the released artifact. diff --git a/.github/workflows/builder.yml b/.github/workflows/builder.yml new file mode 100644 index 0000000..574d5ef --- /dev/null +++ b/.github/workflows/builder.yml @@ -0,0 +1,56 @@ +# This workflow will build the + +name: 🧱 Builder + +on: + push: + branches: + - main + workflow_dispatch: + +concurrency: ${{ github.workflow }}-${{ github.ref }} + +env: + GH_TOKEN: ${{ secrets.RELEASE_BOT_TOKEN }} + +jobs: + release: + name: 📦 Release + if: "!contains(github.event.head_commit.message, 'ci skip') && !contains(github.event.head_commit.message, 'skip ci')" + runs-on: ubuntu-latest + strategy: + matrix: + node-version: [lts/*] + pnpm-version: [latest] + steps: + - name: ⬇️ Checkout + id: checkout + uses: actions/checkout@v2.3.3 + with: + fetch-depth: 0 + token: ${{ env.GH_TOKEN }} + + - name: 🟢 Setup node + id: setup-node + uses: actions/setup-node@v2 + with: + node-version: ${{ matrix.node-version }} + + - name: 🥡 Setup pnpm + id: setup-pnpm + uses: pnpm/action-setup@v2.1.0 + with: + version: ${{ matrix.pnpm-version }} + run_install: false + + - name: 🎈 Get pnpm store directory + id: get-pnpm-cache-dir + run: | + echo "::set-output name=pnpm_cache_dir::$(pnpm store path)" + - name: 🧩 Install Dependencies + id: install-dependencies + run: pnpm install + + - name: 🏗️ Build + id: build + run: pnpm build diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 1d0e910..17d9fad 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -56,6 +56,12 @@ jobs: id: build run: pnpm build + - name: 📦 Prepare for Publish + id: prepare-for-publish + run: | + # Copy the README.md file to the lib directory. + cp README.md lib + - name: 📣 Create Release Pull Request or Publish to npm id: changesets uses: changesets/action@v1 diff --git a/README.md b/README.md index ed13c29..429d518 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,22 @@ -# AsgardeoStrategy +

+

Remix Auth Asgardeo

+

-The Asgardeo strategy, which extends the OAuth2Strategy, is used to authenticate users against an Asgardeo organization. +
+ 🚀 Release + 🧱 Builder + + Stackoverflow + Discord + License + Twitter +
+ +
+ +[Remix Auth](https://remix.run/resources/remix-auth) is a flexible authentication framework for [Remix](https://remix.run/) applications that allows developers to implement various strategies for user authentication. + +The Asgardeo strategy is a custom implementation of the [OAuth2Strategy](https://github.com/sergiodxa/remix-auth-oauth2) designed specifically for integrating with [Asgardeo](https://wso2.com/asgardeo), an identity-as-a-service (IDaaS) platform. This strategy enables developers to authenticate users against an Asgardeo organization using OpenID Connect (OIDC). ## Supported runtimes @@ -109,9 +125,13 @@ export const action = async ({ request }: ActionFunctionArgs) => { }; ``` -## Development +## Contribute +Please read [Contributing Guide](CONTRIBUTING.md) for details on how to contribute to Remix Auth Asgardeo. Refer to [General Contribution Guidelines](http://wso2.github.io/) for details on our code of conduct, and the process for submitting pull requests to us. + +### Reporting issues +We encourage you to report issues, improvements, and feature requests creating [Github Issues](https://github.com/asgardeo/remix-auth-asgardeo/issues). + +**Important**: Please be advised that security issues MUST be reported to security@wso2com, not as GitHub issues, in order to reach the proper audience. We strongly advise following the WSO2 Security Vulnerability Reporting Guidelines when reporting the security issues. -1. Clone this repo. -2. Run `npm install` to install the dependencies. -3. Run `npm link` to create a symlink. -4. Run `npm install remix-auth-asgardeo` in your remix project. +## License +This project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details. diff --git a/lib/package.json b/lib/package.json index 4994e0e..cc938ae 100644 --- a/lib/package.json +++ b/lib/package.json @@ -21,6 +21,7 @@ "strategy", "asgardeo" ], + "type": "module", "main": "./dist/index.js", "types": "./dist/index.d.ts", "files": [