Skip to content
Open
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
8 changes: 8 additions & 0 deletions .changeset/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Changesets

Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
with multi-package repos, or single-package repos to help you version and publish your code. You can
find the full documentation for it [in our repository](https://github.com/changesets/changesets)

We have a quick list of common questions to get you started engaging with this project in
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
11 changes: 11 additions & 0 deletions .changeset/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"$schema": "https://unpkg.com/@changesets/config@3.1.1/schema.json",
"changelog": "@changesets/cli/changelog",
"commit": false,
"fixed": [],
"linked": [],
"access": "public",
"baseBranch": "master",
"updateInternalDependencies": "patch",
"ignore": ["@custom-elements-manifest/root"]
}
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2-beta
with:
node-version: 16
node-version: 18
registry-url: https://registry.npmjs.org

- name: Install Packages
Expand Down
37 changes: 37 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Release

on:
push:
branches:
- master

concurrency: ${{ github.workflow }}-${{ github.ref }}

jobs:
release:
name: Release
runs-on: ubuntu-latest
steps:
- name: Checkout Repo
uses: actions/checkout@v3

- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: 18
cache: 'yarn'

- name: Install Dependencies
run: yarn install --frozen-lockfile

- name: Create Release Pull Request or Publish to npm
id: changesets
uses: changesets/action@v1
with:
publish: yarn release
version: yarn version
commit: 'chore: version packages'
title: 'chore: version packages'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v16.3.0
v18.20.8
61 changes: 61 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Contributing to custom-elements-manifest

## Changesets

This project uses [changesets](https://github.com/changesets/changesets) to manage versioning and changelogs.

### Adding a changeset

When you make changes that should trigger a version bump, you need to add a changeset:

```bash
yarn changeset
```

This will prompt you to:
1. Select which packages have changed
2. Choose the version bump type (major, minor, or patch) for each package
3. Write a summary of the changes

The changeset will be saved as a markdown file in the `.changeset` directory.

### Version bump guidelines

- **Major**: Breaking changes
- **Minor**: New features (backwards compatible)
- **Patch**: Bug fixes and minor improvements

### Releasing

When you're ready to release:

1. **Version packages**: This will consume all changesets and update package versions
```bash
yarn version
```

2. **Publish packages**: This will build, test, and publish all changed packages
```bash
yarn release
```

### Workflow

1. Make your changes
2. Run `yarn changeset` to document your changes
3. Commit your changes along with the changeset file
4. When ready to release, run `yarn version` to update versions
5. Commit the version changes
6. Run `yarn release` to publish to npm

### Internal dependencies

When you update a package that other packages in this monorepo depend on, changesets will automatically bump the dependent packages with a patch version.

### Automated releases (GitHub Actions)

A GitHub Actions workflow (`.github/workflows/release.yml`) has been set up to automate the release process:

1. When changesets are merged to `master`, the workflow creates a "Version Packages" PR
2. This PR contains all version bumps and changelog updates
3. When you merge the "Version Packages" PR, packages are automatically published to npm
12 changes: 8 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,24 @@
"license": "MIT",
"type": "module",
"engines": {
"node": ">=14.5.1"
"node": "^18.0.0"
},
"repository": {
"type": "git",
"url": "https://github.com/open-wc/custom-elements-manifest.git"
},
"scripts": {
"docs": "rocket build",
"start": "rocket start",
"test": "yarn workspaces run test"
"docs": "NODE_OPTIONS='--openssl-legacy-provider' rocket build",
"start": "NODE_OPTIONS='--openssl-legacy-provider' rocket start",
"test": "yarn workspaces run test",
"changeset": "changeset",
"version": "changeset version",
"release": "yarn test && changeset publish"
},
"dependencies": {},
"devDependencies": {
"@asdgf/cli": "^0.0.15",
"@changesets/cli": "^2.29.7",
"@rocket/blog": "^0.3.0",
"@rocket/cli": "^0.9.6",
"@rocket/launch": "^0.5.3",
Expand Down
Loading