Skip to content

Commit c1b806a

Browse files
committed
docs: sync repo link and release.changelog changes
1 parent 0d9e3ab commit c1b806a

2 files changed

Lines changed: 10 additions & 16 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,26 @@
33
[![NPM Version](https://img.shields.io/npm/v/zotero-plugin-scaffold)](https://www.npmjs.com/package/zotero-plugin-scaffold)
44
[![NPM Downloads](https://img.shields.io/npm/dm/zotero-plugin-scaffold)](https://www.npmjs.com/package/zotero-plugin-scaffold)
55
![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/zotero-plugin-scaffold)
6-
![GitHub License](https://img.shields.io/github/license/northword/zotero-plugin-scaffold)
6+
![GitHub License](https://img.shields.io/github/license/zotero-plugin-dev/zotero-plugin-scaffold)
77
[![code style](https://antfu.me/badge-code-style.svg)](https://github.com/antfu/eslint-config)
88

99
This is an npm package designed to assist in the development of Zotero plugins. It provides features such as compiling plugins, starting Zotero and installing plugins from source code, reloading plugins when the source code changes, and releasing plugins, and so on.
1010

1111
Initially, the code of this package was part of the [zotero-plugin-template](https://github.com/windingwind/zotero-plugin-template) repository. To allow downstream developers to easily stay up-to-date, we have abstracted these scripts into a standalone npm package.
1212

13-
This project is under active development, and some APIs may change. However, it is ready for production and has been [used in several projects](https://github.com/northword/zotero-plugin-scaffold/network/dependents).
13+
This project is under active development, and some APIs may change. However, it is ready for production and has been [used in several projects](https://github.com/zotero-plugin-dev/zotero-plugin-scaffold/network/dependents).
1414

1515
For best practices regarding this package, please refer to [zotero-plugin-template](https://github.com/windingwind/zotero-plugin-template).
1616

1717
## Documentation
1818

19-
[Read the Docs to Learn More](https://northword.github.io/zotero-plugin-scaffold).
19+
[Read the Docs to Learn More](https://zotero-plugin-dev.github.io/zotero-plugin-scaffold).
2020

2121
## Contributing
2222

2323
```bash
2424
# Git Clone
25-
git clone https://github.com/northword/zotero-plugin-scaffold.git zotero-plugin-scaffold
25+
git clone https://github.com/zotero-plugin-dev/zotero-plugin-scaffold.git
2626
cd zotero-plugin-scaffold/
2727

2828
# Install deps
@@ -36,7 +36,7 @@ pnpm run dev
3636

3737
# link local scaffold to your plugin
3838
cd your-plugin-work-dir/
39-
pnpm link ../zotero-plugin-scaffold/packages/scaffold/
39+
pnpm link ../zotero-plugin-scaffold/
4040
cd zotero-plugin-scaffold/
4141
```
4242

@@ -60,4 +60,4 @@ GNU Affero General Public License Version 3.
6060

6161
This project references the design and code of the [Zotero Plugin Template](https://github.com/windingwind/zotero-plugin-template).
6262

63-
This project would not be possible without the support of the [open source community](https://github.com/northword/zotero-plugin-scaffold/network/dependencies).
63+
This project would not be possible without the support of the [open source community](https://github.com/zotero-plugin-dev/zotero-plugin-scaffold/network/dependencies).

docs/src/release.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -211,22 +211,16 @@ export default defineConfig({
211211

212212
## Changelog
213213

214-
By default, Scaffold uses `git log` for the changelog, but you can modify this via `release.changelog`.
215-
216-
To generate a changelog based on [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), install `conventional-changelog`:
217-
218-
```bash
219-
npm install -D conventional-changelog
220-
```
221-
222-
Then, set `release.changelog` to `conventional-changelog`:
214+
By default, Scaffold uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) for the changelog, but you can modify this via `release.changelog`.
223215

224216
```ts twoslash
225217
import { defineConfig } from "zotero-plugin-scaffold";
226218
// ---cut---
227219
export default defineConfig({
228220
release: {
229-
changelog: "conventional-changelog"
221+
changelog: (ctx, commits) => {
222+
return commits.map(c => c.message).join("\n");
223+
}
230224
}
231225
});
232226
```

0 commit comments

Comments
 (0)