Skip to content

chore(repo): Add backport script #1959

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.

Sign up for GitHub

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
LekoArts merged 5 commits into from
Oct 31, 2023
Merged

chore(repo): Add backport script #1959

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
47bd97a
feat(repo): Add backport script
LekoArts Oct 30, 2023
983552e
chore(repo): Add instructions
LekoArts Oct 30, 2023
f86a15e
chore(repo): Fix linting
LekoArts Oct 30, 2023
5fa3904
Merge branch 'main' into lekoarts/sdk-878-add-backport-script
LekoArts Oct 31, 2023
acb8ad6
Merge branch 'main' into lekoarts/sdk-878-add-backport-script
LekoArts Oct 31, 2023
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
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,6 @@ test-results

# verdaccio
.verdaccio

scripts/.env
!scripts/.env.example
2 changes: 1 addition & 1 deletion .lintstagedrc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"*.{js,jsx,ts,tsx}": ["npx prettier --write", "npx eslint --fix"],
"*.{mjs,js,jsx,ts,tsx}": ["npx prettier --write", "npx eslint --fix"],
"*.{json,md,mdx}": ["npx prettier --write"]
}
16 changes: 14 additions & 2 deletions docs/PUBLISH.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

_Note: Only core maintainers can publish packages._

_Package versioning and publishing is currently handled by @clerkinc/frontend-team._

## Publishing stable package versions (`@latest`)

We are using [changesets](https://github.com/changesets/changesets), so our CICD is using [`changesets/action`](https://github.com/changesets/action) to automate the release process when releasing stable package versions targeting the `@latest` tag.
Expand Down Expand Up @@ -42,3 +40,17 @@ Notes:
## Publishing canary package versions (`@canary`)

We're still considering whether switching the repo into a `canary` mode for big, experimental features makes sense. There is no use case for this right now, however, we might experiment with the [changesets prerelease mode](https://github.com/changesets/changesets/blob/main/docs/prereleases.md) in the future.

## Backporting PRs

@LekoArts LekoArts Oct 30, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lemme know if you'd want any more details on this for that section


> 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`.

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:

```shell
node backports.mjs main-v4 1234
```

The command above will backport the PR `1234` to the branch `main-v4`.
Loading