Skip to content

chore(repo): Rename clerkinc to clerk ❤️ #2023

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .changeset/changelog.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
const { getInfo, getInfoFromPullRequest } = require('@changesets/get-github-info');

const repo = 'clerkinc/javascript';
const repo = 'clerk/javascript';

const getDependencyReleaseLine = async (changesets, dependenciesUpdated) => {
if (dependenciesUpdated.length === 0) return '';
Expand Down
2 changes: 2 additions & 0 deletions .changeset/clever-wasps-invite.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
---
4 changes: 2 additions & 2 deletions .changeset/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"changelog": [
"./changelog.js",
{
"repo": "clerkinc/javascript"
"repo": "clerk/javascript"
}
],
"commit": false,
Expand All @@ -21,4 +21,4 @@
"onlyUpdatePeerDependentsWhenOutOfRange": true,
"updateInternalDependents": "always"
}
}
}
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ body:
I have reviewed the documentation: https://clerk.com/docs
required: true
- label: |
I have searched for existing issues: https://github.com/clerkinc/javascript/issues
I have searched for existing issues: https://github.com/clerk/javascript/issues
required: true
- label: |
I have not already reached out to Clerk support via email or Discord (if you have, no need to open an issue here)
Expand All @@ -35,7 +35,7 @@ body:
Link to a minimal reproduction (GitHub repository, CodeSandbox, StackBlitz, etc.) or a [Replay recording](https://www.replay.io/).

**Do not link to your actual project**, but provide a minimal reproduction in a fresh project.

Instructions:
- [How to create a minimal reproduction](https://clerkdev.notion.site/Creating-a-Minimal-Reproduction-0436afc4203f41aa9aa8700968aaef48?pvs=4)
- [How to record a Replay](https://docs.replay.io/bug-reports/recording-a-replay)
Expand Down
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Description

<!--
Thanks for contributing to Clerk. Make sure to read the contributing guide at https://github.com/clerkinc/javascript/blob/main/docs/CONTRIBUTING.md before opening a PR!
Thanks for contributing to Clerk. Make sure to read the contributing guide at https://github.com/clerk/javascript/blob/main/docs/CONTRIBUTING.md before opening a PR!

**Please create a feature request before starting work on any significant change.**

Expand All @@ -18,7 +18,7 @@
- [ ] `npm test` runs as expected.
- [ ] `npm run build` runs as expected.
- [ ] (If applicable) [JSDoc comments](https://jsdoc.app/about-getting-started.html) have been added or updated for any package exports
- [ ] (If applicable) [Documentation](https://github.com/clerkinc/clerk-docs) has been updated
- [ ] (If applicable) [Documentation](https://github.com/clerk/clerk-docs) has been updated

## Type of change

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/base-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ on:

jobs:
build:
# if: ${{ github.repository == 'clerkinc/javascript' }}
# if: ${{ github.repository == 'clerk/javascript' }}
runs-on: ${{ vars.RUNNER_NORMAL }}
steps:
- name: Checkout repo
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/lock-threads.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ jobs:

We currently close issues after 40 days of inactivity. It's been 30 days since the last update here. If we missed this issue, please reply here. Otherwise, we'll close this issue in 10 days.

As a friendly reminder: The best way to see an issue fixed is to open a pull request. If you're not sure how to do that, please check out our [contributing guide](https://github.com/clerkinc/javascript/blob/main/docs/CONTRIBUTING.md).
As a friendly reminder: The best way to see an issue fixed is to open a pull request. If you're not sure how to do that, please check out our [contributing guide](https://github.com/clerk/javascript/blob/main/docs/CONTRIBUTING.md).

Thanks for being a part of the Clerk community! 🙏
stale-pr-message: |
Expand All @@ -47,7 +47,7 @@ jobs:

After 40 days of no activity, we'll close this issue. Keep in mind, I'm just a robot, so if I've closed this issue in error, please reply here and my human colleagues will reopen it.

As a friendly reminder: The best way to see an issue fixed is to open a pull request. If you're not sure how to do that, please check out our [contributing guide](https://github.com/clerkinc/javascript/blob/main/docs/CONTRIBUTING.md).
As a friendly reminder: The best way to see an issue fixed is to open a pull request. If you're not sure how to do that, please check out our [contributing guide](https://github.com/clerk/javascript/blob/main/docs/CONTRIBUTING.md).

Thanks for being a part of the Clerk community! 🙏
close-pr-message: |
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/release-prod.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ concurrency:
jobs:
release:
name: Release
if: ${{ github.repository == 'clerkinc/javascript' }}
if: ${{ github.repository == 'clerk/javascript' }}
runs-on: ${{ vars.RUNNER_NORMAL }}
permissions:
contents: write
Expand Down Expand Up @@ -58,7 +58,7 @@ jobs:
script: |
const clerkjsVersion = require('./packages/clerk-js/package.json').version;
github.rest.actions.createWorkflowDispatch({
owner: 'clerkinc',
owner: 'clerk',
repo: 'cloudflare-workers',
workflow_id: 'prepare-prod-clerkjs-proxy-pr.yml',
ref: 'main',
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/release-snapshot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ concurrency:

jobs:
snapshot-release:
if: ${{ startsWith(github.event.comment.body, '!snapshot') && github.repository == 'clerkinc/javascript' && github.event.issue.pull_request }}
if: ${{ startsWith(github.event.comment.body, '!snapshot') && github.repository == 'clerk/javascript' && github.event.issue.pull_request }}
runs-on: ${{ vars.RUNNER_LARGE }}
env:
TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
Expand All @@ -29,7 +29,7 @@ jobs:
github-token: ${{ secrets.CLERK_COOKIE_PAT }}
script: |
const isMember = await github.rest.orgs.checkMembershipForUser({
org: 'clerkinc',
org: 'clerk',
username: context.actor
});
if (!isMember) {
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/release-staging.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ concurrency:

jobs:
staging-release:
if: ${{ github.repository == 'clerkinc/javascript' }}
if: ${{ github.repository == 'clerk/javascript' }}
runs-on: ${{ vars.RUNNER_NORMAL }}
env:
TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
Expand Down Expand Up @@ -51,9 +51,9 @@ jobs:
const nextjsVersion = require('./packages/nextjs/package.json').version;

if (clerkjsVersion.includes('staging')) {
console.log('clerk-js changed, will notify clerkinc/cloudflare-workers');
console.log('clerk-js changed, will notify clerk/cloudflare-workers');
github.rest.actions.createWorkflowDispatch({
owner: 'clerkinc',
owner: 'clerk',
repo: 'cloudflare-workers',
workflow_id: 'release-staging-clerkjs-proxy.yml',
ref: 'main',
Expand All @@ -62,9 +62,9 @@ jobs:
}

if (nextjsVersion.includes('staging')) {
console.log('clerk/nextjs changed, will notify clerkinc/accounts');
console.log('clerk/nextjs changed, will notify clerk/accounts');
github.rest.actions.createWorkflowDispatch({
owner: 'clerkinc',
owner: 'clerk',
repo: 'accounts',
workflow_id: 'release-staging.yml',
ref: 'main',
Expand Down
2 changes: 1 addition & 1 deletion CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1 +1 @@
* @clerkinc/team-sdk
* @clerk/team-sdk
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,16 +55,16 @@ Clerk's full documentation is available at [clerk.com/docs](https://clerk.com/do

## 🚢 Release Notes

Curious what we shipped recently? You can browse the [GitHub Releases](https://github.com/clerkinc/javascript/releases) page or look at the individual `CHANGELOG.md` files inside each package (e.g. [`clerk-js CHANGELOG`](https://github.com/clerkinc/javascript/blob/main/packages/clerk-js/CHANGELOG.md)).
Curious what we shipped recently? You can browse the [GitHub Releases](https://github.com/clerk/javascript/releases) page or look at the individual `CHANGELOG.md` files inside each package (e.g. [`clerk-js CHANGELOG`](https://github.com/clerk/javascript/blob/main/packages/clerk-js/CHANGELOG.md)).

## 🤝 How to Contribute

We're open to all community contributions! If you'd like to contribute in any way, please read [our contribution guidelines](https://github.com/clerkinc/javascript/blob/main/docs/CONTRIBUTING.md). We'd love to have you as part of the Clerk community!
We're open to all community contributions! If you'd like to contribute in any way, please read [our contribution guidelines](https://github.com/clerk/javascript/blob/main/docs/CONTRIBUTING.md). We'd love to have you as part of the Clerk community!

It'll show you how to make changes to the SDKs, open pull requests, or submitting issues. If you want to add or edit localizations (e.g. how a button text is translated to your language), you can check out the [`localizations` README](./packages/localizations/README.md).

## 📝 License

This project is licensed under the **MIT license**.

See [LICENSE](https://github.com/clerkinc/javascript/blob/main/LICENSE) for more information.
See [LICENSE](https://github.com/clerk/javascript/blob/main/LICENSE) for more information.
14 changes: 7 additions & 7 deletions docs/CICD.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,24 @@ Every time a PR is merged into `main`, an automated staging release will happen.

## Stable releases

A stable release will be triggered every time the "Version Packages" PR is merged. Once versioning and publishing is done, the `clerkinc/javascript` repo will dispatch a workflow event, notifying other related Clerk repos of the new releases.
A stable release will be triggered every time the "Version Packages" PR is merged. Once versioning and publishing is done, the `clerk/javascript` repo will dispatch a workflow event, notifying other related Clerk repos of the new releases.

Actions that will be triggered:

- `clerkinc/cloudflare-workers`: The latest clerk-js versions in `clerkjs-proxy/wrangler.toml` will be updated a PR will open. Follow the instructions in the PR to manually release a new `clerkjs-proxy` worker.
- `clerk/cloudflare-workers`: The latest clerk-js versions in `clerkjs-proxy/wrangler.toml` will be updated a PR will open. Follow the instructions in the PR to manually release a new `clerkjs-proxy` worker.

For more details, refer to [PUBLISH.md](https://github.com/clerkinc/javascript/blob/main/docs/PUBLISH.md).
For more details, refer to [PUBLISH.md](https://github.com/clerk/javascript/blob/main/docs/PUBLISH.md).

## Automated staging releases

A staging release will be triggered every time PR is merged into `main`. Once versioning and publishing is done, the `clerkinc/javascript` repo will dispatch a workflow event, notifying other related Clerk repos of the new releases.
A staging release will be triggered every time PR is merged into `main`. Once versioning and publishing is done, the `clerk/javascript` repo will dispatch a workflow event, notifying other related Clerk repos of the new releases.

Actions that will be triggered:

- `clerkinc/cloudflare-workers`: The latest clerk-js versions in `clerkjs-proxy/wrangler.toml` will be updated and directly committed to `main`. A second workflow will perform a staging release of the `clerkjs-proxy` worker.
- `clerkinc/accounts`: A new Accounts deployment will take place, using the most recent staging `@clerk/nextjs` version. This change will not be committed to `main`.
- `clerk/cloudflare-workers`: The latest clerk-js versions in `clerkjs-proxy/wrangler.toml` will be updated and directly committed to `main`. A second workflow will perform a staging release of the `clerkjs-proxy` worker.
- `clerk/accounts`: A new Accounts deployment will take place, using the most recent staging `@clerk/nextjs` version. This change will not be committed to `main`.

For more details about staging releases, refer to [PUBLISH.md](https://github.com/clerkinc/javascript/blob/main/docs/PUBLISH.md).
For more details about staging releases, refer to [PUBLISH.md](https://github.com/clerk/javascript/blob/main/docs/PUBLISH.md).

## Quality checks

Expand Down
14 changes: 7 additions & 7 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Contributing guide

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we have a [code of conduct](https://github.com/clerkinc/javascript/blob/main/docs/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
Please note we have a [code of conduct](https://github.com/clerk/javascript/blob/main/docs/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.

<details open="open">
<summary><strong>TABLE OF CONTENTS</strong></summary>
Expand Down Expand Up @@ -57,7 +57,7 @@ To set up your development environment, please follow these steps:
1. Clone the repo

```sh
git clone https://github.com/clerkinc/javascript
git clone https://github.com/clerk/javascript
```

2. Install the dependencies. We're using npm workspaces, so you **should always run `npm install` from the root of the monorepo**, as it will install dependencies for all the packages:
Expand All @@ -77,21 +77,21 @@ For package specific setup, refer to the `Build` section of the specific package

### Documenting your changes

Updating documentation is an important part of the contribution process. If you are changing existing behavior or adding a new feature, make sure [Clerk's documentation](https://github.com/clerkinc/clerk-docs) is also updated.
Updating documentation is an important part of the contribution process. If you are changing existing behavior or adding a new feature, make sure [Clerk's documentation](https://github.com/clerk/clerk-docs) is also updated.

To improve the in-editor experience when using Clerk's SDKs, we do our best to add [JSDoc comments](https://jsdoc.app/about-getting-started.html) to our package's public exports. The JSDoc comments should not attempt to duplicate any existing type information, but should provide meaningful additional context or references. If you are adding a new export, make sure it has a JSDoc comment. If you are updating an existing export, make sure any existing comments are updated appropriately.

## Opening a Pull Request

1. Search our repository for open or closed
[Pull Requests](https://github.com/clerkinc/javascript/pulls)
[Pull Requests](https://github.com/clerk/javascript/pulls)
that relate to your submission. You don't want to duplicate effort.
2. Fork the project
3. Create your feature branch (`git checkout -b feat/amazing_feature`)
4. If required, create a `changeset` that describes your changes (`npm run changeset`). In cases where a changeset is not required, an empty changeset can be created instead (`npm run changeset:empty`) - an empty changeset will not generate a changelog entry for the change, so please use it as an escape hatch or for internal refactors only.
5. Commit your changes (`git commit -m 'feat: Add amazing_feature'`)
6. Push to the branch (`git push origin feat/amazing_feature`)
7. [Open a Pull Request](https://github.com/clerkinc/javascript/compare?expand=1). Make sure the description includes enough information for the reviewer to understand what the PR is about.
7. [Open a Pull Request](https://github.com/clerk/javascript/compare?expand=1). Make sure the description includes enough information for the reviewer to understand what the PR is about.
8. Follow the instructions of the pull request template

### Changesets
Expand Down Expand Up @@ -172,7 +172,7 @@ All of these are used to describe changes in the codebase, but they have differe

## Issues and feature requests

You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by [submitting an issue on GitHub](https://github.com/clerkinc/javascript/issues). Before you create an issue, make sure to search the issue archive - your issue may have already been addressed! Please ensure that you have read and followed the bug report template, otherwise we will have to close the issue. You can submit a feature request by visiting [feedback.clerk.com](https://feedback.clerk.com).
You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by [submitting an issue on GitHub](https://github.com/clerk/javascript/issues). Before you create an issue, make sure to search the issue archive - your issue may have already been addressed! Please ensure that you have read and followed the bug report template, otherwise we will have to close the issue. You can submit a feature request by visiting [feedback.clerk.com](https://feedback.clerk.com).

Issues that have the label `needs-triage` have been seen by our team and are queued for triage internally. Issues that have the label `prioritized` have been discussed and are either in our backlog or being worked on actively. We do our best to prioritize work across a wide variety of sources, only one of which is github issues. While we understand that it can be frustrating if it takes a while for a patch to land, we ask for your understanding in that we have quite a lot of things that need to be worked on at any given time and are still a small team. And remember, the best way to get something fixed in an open source library is to contribute the fix yourself!

Expand All @@ -186,7 +186,7 @@ If you want to add or edit localizations (e.g. how a button text is translated t

_Note: Only core maintainers can publish packages._

For more information visit [publish documentation](https://github.com/clerkinc/javascript/blob/main/docs/PUBLISH.md).
For more information visit [publish documentation](https://github.com/clerk/javascript/blob/main/docs/PUBLISH.md).

## License

Expand Down
4 changes: 2 additions & 2 deletions docs/PUBLISH.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Snapshot releases are a way to release your changes for testing without updating
**Important:**
Before requesting a snapshot release, ensure that your Clerk organization membership status is set to "Public". Otherwise, the snapshot release will fail. To set your status to "Public", follow [these steps](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/publicizing-or-hiding-organization-membership).

To perform a snapshot release, simply comment `!snapshot` in your PR. Once the packages are built and published (~2mins), [clerk-cookie](https://github.com/clerk-cookie) will post a reply with the published versions ([example](https://github.com/clerkinc/javascript/pull/1329#issuecomment-1586970784)). Simply install the snap version using `npm install` as usual.
To perform a snapshot release, simply comment `!snapshot` in your PR. Once the packages are built and published (~2mins), [clerk-cookie](https://github.com/clerk-cookie) will post a reply with the published versions ([example](https://github.com/clerk/javascript/pull/1329#issuecomment-1586970784)). Simply install the snap version using `npm install` as usual.

Notes:

Expand All @@ -45,7 +45,7 @@ We're still considering whether switching the repo into a `canary` mode for big,

> Backporting is the action of taking parts from a newer version of a software system or software component and porting them to an older version of the same software.

If a PR got merged into `main` that should also be released in older versions (e.g. critical security fixes), you'll need to backport said PR. You can do this by using the [`backport` script](https://github.com/clerkinc/javascript/blob/main/scripts/backport.mjs) inside `scripts`.
If a PR got merged into `main` that should also be released in older versions (e.g. critical security fixes), you'll need to backport said PR. You can do this by using the [`backport` script](https://github.com/clerk/javascript/blob/main/scripts/backport.mjs) inside `scripts`.

Duplicate the `.env.example` file inside `scripts` and rename it to `.env`. Fill out the `GITHUB_ACCESS_TOKEN` variable. Afterwards, you'll be able to run the CLI like so:

Expand Down
Loading