Skip to content
This repository has been archived by the owner on May 31, 2023. It is now read-only.

Commit

Permalink
chore: introduce changesets
Browse files Browse the repository at this point in the history
  • Loading branch information
joe-bell committed Jun 18, 2022
1 parent adf88de commit e950565
Show file tree
Hide file tree
Showing 12 changed files with 646 additions and 206 deletions.
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)
5 changes: 5 additions & 0 deletions .changeset/chilled-eels-drum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"plaiceholder": minor
---

Fixes a bug in the CSS logic if the source contains transparency (thanks @skirsten!)
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/[email protected]/schema.json",
"changelog": "@changesets/cli/changelog",
"commit": false,
"fixed": [["plaiceholder", "@plaiceholder/*"]],
"linked": [],
"access": "restricted",
"baseBranch": "main",
"updateInternalDependencies": "patch",
"ignore": ["example-*"]
}
5 changes: 5 additions & 0 deletions .changeset/honest-comics-sin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@plaiceholder/tailwindcss": patch
---

Add `sharp` to peerDependencies to avoid installation confusion
100 changes: 0 additions & 100 deletions CHANGELOG.md

This file was deleted.

61 changes: 58 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,57 @@ pnpm <script-name> --filter <package-name>

A trade-off with using a personal repo is that permissions are fairly locked-down. In the mean-time releases will be made manually by the project owner.

Releases and versioning are handled by [Changesets](https://pnpm.io/using-changesets).

### Adding Changesets

```sh
pnpm changeset
```

### Publishing

1. Switch into the default branch

```sh
git checkout main
```

2. Bump packages and generate `CHANGELOG.md`s based on the previously specified
changesets.

```sh
pnpm changeset version
```

3. Regenerate the lockfile

```sh
pnpm install
```

4. Create a commit with the shared version, and push

```sh
git commit vX.X.X
```

5. Publish all packages to npm

```sh
pnpm publish -r
```

6. Create a tag with the shared version, then push the commit and tag

```sh
git tag vX.X.X
git push
git push origin refs/tags/vX.X.X
```

7. [Create a release](https://github.com/joe-bell/plaiceholder/releases/new), using the newly pushed tag

## Implementations

So, you want to build an alternative Plaiceholder implementation? Great!
Expand All @@ -70,9 +121,9 @@ Please respect that Plaiceholder is just the end result – countless hours of w
When building your own implementation, you should meet the following requirements:

- Branding
-**Don't** use the "Plaiceholder" name on its own, the logo, tagline or any of the marketing copy from either the [plaiceholder.co](https://plaiceholder.co) domain or [docs](https://plaiceholder.co/docs).
-**Don't** use the "Plaiceholder" name on its own, the logo, tagline or any of the marketing copy from either the [plaiceholder.co](https://plaiceholder.co) domain or [docs](https://plaiceholder.co/docs).
The "[Plaiceholder](https://plaiceholder.co)" project is a trading name of "Big Attic OÜ", and therefore should not be confused with affiliation.
-**Do** name your project with the `-plaiceholder` suffix **or** `plaiceholder-` prefix.
-**Do** name your project with the `-plaiceholder` suffix **or** `plaiceholder-` prefix.
e.g. your repo or package, could be called `rust-plaiceholder`, your function could be called `rustPlaiceholder` (but **not** `plaiceholder`).
- Credit

Expand All @@ -84,7 +135,7 @@ When building your own implementation, you should meet the following requirement

```md
<p align="center">
An externally-maintained implementation of
An externally-maintained implementation of
<strong>
<a href="https://github.com/joe-bell/plaiceholder">
Plaiceholder
Expand Down Expand Up @@ -119,3 +170,7 @@ If you have any questions above the above requirements, please feel free to [rea
### Raise a PR

Once you've completed the above, raise a PR to add your implementation to the [Community page](https://plaiceholder.co/docs/community).

```

```
47 changes: 0 additions & 47 deletions examples/11ty/CHANGELOG.md

This file was deleted.

1 change: 0 additions & 1 deletion examples/11ty/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"private": true,
"name": "example-with-11ty",
"version": "2.3.0",
"author": "Joe Bell <[email protected]>",
"license": "Apache-2.0",
"scripts": {
Expand Down
49 changes: 0 additions & 49 deletions examples/next/CHANGELOG.md

This file was deleted.

1 change: 0 additions & 1 deletion examples/next/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"private": true,
"name": "example-with-next",
"version": "2.3.0",
"author": "Joe Bell <[email protected]>",
"license": "Apache-2.0",
"scripts": {
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
"prepare": "[[ \"$CI\" -ne \"1\" ]] && [[ \"CI\" != 'true' ]] && pnpm build || echo 'Skipping prepare'"
},
"devDependencies": {
"@changesets/cli": "2.23.0",
"@commitlint/cli": "13.1.0",
"@commitlint/config-conventional": "13.1.0",
"commitizen": "4.2.4",
Expand Down
Loading

0 comments on commit e950565

Please sign in to comment.