Skip to content
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
30 changes: 17 additions & 13 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,30 @@ on:

jobs:
lint:
name: "Lint and compile"
name: 'Lint and compile'
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- uses: volta-cli/action@v1
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
- uses: actions/setup-node@v4
with:
node-version: 14.x
- run: yarn install --frozen-lockfile
- run: yarn lint
- run: yarn compile
node-version-file: package.json
cache: pnpm
- run: pnpm install --frozen-lockfile
- run: pnpm lint
- run: pnpm compile

test:
name: "Test"
name: 'Test'
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- uses: volta-cli/action@v1
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
- uses: actions/setup-node@v4
with:
node-version: 14.x
- run: yarn install --frozen-lockfile
- run: yarn test
node-version-file: package.json
cache: pnpm
- run: pnpm install --frozen-lockfile
- run: pnpm test
94 changes: 94 additions & 0 deletions .github/workflows/plan-release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
name: Plan Release
on:
workflow_dispatch:
push:
branches:
- main
- master
pull_request_target: # This workflow has permissions on the repo, do NOT run code from PRs in this workflow. See https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
types:
- labeled
- unlabeled

concurrency:
group: plan-release # only the latest one of these should ever be running
cancel-in-progress: true

jobs:
is-this-a-release:
name: "Is this a release?"
runs-on: ubuntu-latest
outputs:
command: ${{ steps.check-release.outputs.command }}

steps:
- uses: actions/checkout@v4
with:
fetch-depth: 2
ref: 'main'
# This will only cause the `is-this-a-release` job to have a "command" of `release`
# when the .release-plan.json file was changed on the last commit.
- id: check-release
run: if git diff --name-only HEAD HEAD~1 | grep -w -q ".release-plan.json"; then echo "command=release"; fi >> $GITHUB_OUTPUT

create-prepare-release-pr:
name: Create Prepare Release PR
runs-on: ubuntu-latest
timeout-minutes: 5
needs: is-this-a-release
permissions:
contents: write
issues: read
pull-requests: write
# only run on push event or workflow dispatch if plan wasn't updated (don't create a release plan when we're releasing)
# only run on labeled event if the PR has already been merged
if: ((github.event_name == 'push' || github.event_name == 'workflow_dispatch') && needs.is-this-a-release.outputs.command != 'release') || (github.event_name == 'pull_request_target' && github.event.pull_request.merged == true)

steps:
- uses: actions/checkout@v4
# We need to download lots of history so that
# github-changelog can discover what's changed since the last release
with:
fetch-depth: 0
ref: 'main'
- uses: pnpm/action-setup@v4
- uses: actions/setup-node@v4
with:
node-version: 18
cache: pnpm
- run: pnpm install --frozen-lockfile
- name: "Generate Explanation and Prep Changelogs"
id: explanation
run: |
set +e
pnpm release-plan prepare 2> >(tee -a release-plan-stderr.txt >&2)

if [ $? -ne 0 ]; then
release_plan_output=$(cat release-plan-stderr.txt)
else
release_plan_output=$(jq .description .release-plan.json -r)
rm release-plan-stderr.txt

if [ $(jq '.solution | length' .release-plan.json) -eq 1 ]; then
new_version=$(jq -r '.solution[].newVersion' .release-plan.json)
echo "new_version=v$new_version" >> $GITHUB_OUTPUT
fi
fi
echo 'text<<EOF' >> $GITHUB_OUTPUT
echo "$release_plan_output" >> $GITHUB_OUTPUT
echo 'EOF' >> $GITHUB_OUTPUT
env:
GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}

- uses: peter-evans/create-pull-request@v7
with:
commit-message: "Prepare Release ${{ steps.explanation.outputs.new_version}} using 'release-plan'"
labels: "internal"
branch: release-preview
title: Prepare Release ${{ steps.explanation.outputs.new_version }}
body: |
This PR is a preview of the release that [release-plan](https://github.com/embroider-build/release-plan) has prepared. To release you should just merge this PR 👍

-----------------------------------------

${{ steps.explanation.outputs.text }}
43 changes: 43 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# For every push to the primary branch with .release-plan.json modified,
# runs release-plan.

name: Publish Stable

on:
workflow_dispatch:
push:
branches:
- main
- master
paths:
- '.release-plan.json'

concurrency:
group: publish-${{ github.head_ref || github.ref }}
cancel-in-progress: true

jobs:
publish:
name: "NPM Publish"
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write
id-token: write
attestations: write

steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
- uses: actions/setup-node@v4
with:
node-version: 18
# This creates an .npmrc that reads the NODE_AUTH_TOKEN environment variable
registry-url: 'https://registry.npmjs.org'
cache: pnpm
- run: pnpm install --frozen-lockfile
- name: Publish to NPM
run: NPM_CONFIG_PROVENANCE=true pnpm release-plan publish
env:
GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright 2014-2021 Cerebris Corporation
Copyright 2014-2025 Cerebris Corporation

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,32 +47,32 @@ Orbit's main packages are maintained in this monorepo and managed by
Install dependencies:

```
yarn install
pnpm install
```

### Building

Build distributions for all packages:

```
yarn build
pnpm build
```

### Testing

Test all packages:

```
yarn test
pnpm test
```

Or `cd` into each package's dir and test it individually in the browser:

```
cd packages/@orbit/PACKAGE-NAME
yarn testem
pnpm testem
```

## License

Copyright 2014-2021 Cerebris Corporation. MIT License (see LICENSE for details).
Copyright 2014-2025 Cerebris Corporation. MIT License (see LICENSE for details).
27 changes: 27 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Release Process

Releases in this repo are mostly automated using [release-plan](https://github.com/embroider-build/release-plan/). Once you label all your PRs correctly (see below) you will have an automatically generated PR that updates your CHANGELOG.md file and a `.release-plan.json` that is used to prepare the release once the PR is merged.

## Preparation

Since the majority of the actual release process is automated, the remaining tasks before releasing are:

- correctly labeling **all** pull requests that have been merged since the last release
- updating pull request titles so they make sense to our users

Some great information on why this is important can be found at [keepachangelog.com](https://keepachangelog.com/en/1.1.0/), but the overall
guiding principle here is that changelogs are for humans, not machines.

When reviewing merged PR's the labels to be used are:

- breaking - Used when the PR is considered a breaking change.
- enhancement - Used when the PR adds a new feature or enhancement.
- bug - Used when the PR fixes a bug included in a previous release.
- documentation - Used when the PR adds or updates documentation.
- internal - Internal changes or things that don't fit in any other category.

**Note:** `release-plan` requires that **all** PRs are labeled. If a PR doesn't fit in a category it's fine to label it as `internal`

## Release

Once the prep work is completed, the actual release is straight forward: you just need to merge the open [Plan Release](https://github.com/orbitjs/orbit/pulls?q=is%3Apr+is%3Aopen+%22Prepare+Release%22+in%3Atitle) PR
10 changes: 0 additions & 10 deletions lerna.json

This file was deleted.

40 changes: 22 additions & 18 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
"name": "@orbit/orbit",
"private": true,
"description": "Core library for Orbit - a flexible data access and synchronization layer.",
"contributors": [
"Dan Gebhardt <dan@cerebris.com>"
],
"keywords": [
"orbit",
"orbit.js",
Expand All @@ -13,24 +10,31 @@
],
"repository": "https://github.com/orbitjs/orbit",
"license": "MIT",
"contributors": [
"Dan Gebhardt <dan@cerebris.com>"
],
"scripts": {
"postinstall": "lerna bootstrap",
"build": "lerna run build",
"compile": "lerna run build && lerna run compile",
"test": "lerna run build && lerna run --concurrency 1 test",
"lint": "lerna run lint"
"build": "pnpm -r run build",
"compile": "pnpm -r run build && pnpm -r run compile",
"lint": "pnpm -r run lint",
"test": "pnpm -r run build && pnpm -r --workspace-concurrency=1 run test"
},
"prettier": "@orbit/prettier-config",
"devDependencies": {
"@orbit/prettier-config": "^1.0.0",
"lerna": "^3.22.1",
"prettier": "^2.2.1"
},
"prettier": "@orbit/prettier-config",
"volta": {
"node": "14.17.3",
"yarn": "1.22.17"
"@typescript-eslint/eslint-plugin": "^4.15.1",
"@typescript-eslint/parser": "^4.15.1",
"eslint": "^7.20.0",
"eslint-config-prettier": "^7.2.0",
"eslint-plugin-prettier": "^3.3.1",
"prettier": "^2.2.1",
"release-plan": "^0.17.0",
"snowpack": "^3.0.11",
"testem": "^3.2.0"
},
"workspaces": [
"packages/@orbit/*"
]
"packageManager": "pnpm@10.16.1",
"engines": {
"node": ">= 18",
"pnpm": ">= 10"
}
}
7 changes: 2 additions & 5 deletions packages/@orbit/build/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,10 @@
"dependencies": {
"@orbit/prettier-config": "^1.0.0",
"@types/qunit": "^2.11.3",
"@typescript-eslint/eslint-plugin": "^4.15.1",
"@typescript-eslint/parser": "^4.15.1",
"eslint": "^7.20.0",
"eslint-config-prettier": "^7.2.0",
"eslint-plugin-prettier": "^3.3.1",
"prettier": "^2.2.1",
"qunit": "^2.14.0",
"resolve": "^1.22.0",
"rimraf": "^3.0.2",
"snowpack": "^3.0.11",
"testem": "^3.2.0",
"typescript": "^4.5.4",
Expand Down
2 changes: 1 addition & 1 deletion packages/@orbit/coordinator/LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright 2014-2021 Cerebris Corporation
Copyright 2014-2025 Cerebris Corporation

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
Expand Down
10 changes: 5 additions & 5 deletions packages/@orbit/coordinator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@ npm install @orbit/coordinator
To install dependencies:

```
yarn install
pnpm install
```

### Building

Distributions can be built to the `/dist` directory by running:

```
yarn build
pnpm build
```

### Testing
Expand All @@ -42,7 +42,7 @@ yarn build
Test in CI mode by running:

```
yarn test
pnpm test
```

#### Browser Testing
Expand All @@ -51,9 +51,9 @@ Test within a browser
(at [http://localhost:8080/](http://localhost:8080/)) by running:

```
yarn start
pnpm start
```

## License

Copyright 2014-2021 Cerebris Corporation. MIT License (see LICENSE for details).
Copyright 2014-2025 Cerebris Corporation. MIT License (see LICENSE for details).
Loading