Skip to content

Commit fb0791a

Browse files
authored
Merge pull request #1743 from nextcloud-libraries/chore/releas
prepare v1.10.0 and document release process
2 parents d8cdbc9 + 35a1301 commit fb0791a

File tree

6 files changed

+100
-3
lines changed

6 files changed

+100
-3
lines changed

.github/release.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes
2+
# SPDX-FileCopyrightText: 2021-2024 Nextcloud GmbH and Nextcloud contributors
3+
# SPDX-License-Identifier: CC0-1.0
4+
changelog:
5+
exclude:
6+
authors:
7+
- dependabot
8+
- dependabot[bot]
9+
- nextcloud-bot
10+
- nextcloud-command
11+
labels:
12+
- automated
13+
- dependencies
14+
- duplicate
15+
- invalid
16+
- l10n
17+
- question
18+
- wontfix
19+
20+
categories:
21+
- title: 🔐 Security
22+
labels:
23+
- security
24+
- title: 💥 Breaking Changes
25+
labels:
26+
- breaking
27+
- title: 🚀 Enhancements
28+
labels:
29+
- enhancement
30+
- title: 🐛 Fixed bugs
31+
labels:
32+
- bug
33+
- title: Other Changes
34+
labels:
35+
- "*"

CHANGELOG.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,19 @@
44
-->
55
# Changelog
66

7+
## [v1.10.0](https://github.com/nextcloud-libraries/nextcloud-upload/tree/v1.10.0) \(2025-05-05\)
8+
9+
### Added
10+
* feat(Uploader): Enable chunked upload for public shares if supported [\#1705](https://github.com/nextcloud-libraries/nextcloud-upload/pull/1705) \([provokateurin](https://github.com/provokateurin)\)
11+
12+
### Fixed
13+
* fix(i18n): Corrected plural for multi. plural languages [\#1733](https://github.com/nextcloud-libraries/nextcloud-upload/pull/1733) \([rakekniven](https://github.com/rakekniven)\)
14+
15+
### Changed
16+
* chore(i18n): Improved grammar [\#1672](https://github.com/nextcloud-libraries/nextcloud-upload/pull/1672) \([rakekniven](https://github.com/rakekniven)\)
17+
* chore(deps): Bump axios to 1.9.0
18+
* Updated translations
19+
720
## [v1.9.1](https://github.com/nextcloud-libraries/nextcloud-upload/tree/v1.9.1) \(2025-03-20\)
821

922
### Fixed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,27 @@ Nextcloud upload helpers for Nextcloud apps
1212

1313
## Usage
1414
📘 [API documentation](https://nextcloud-libraries.github.io/nextcloud-upload)
15+
16+
## Development
17+
18+
### 📤 Releasing a new version
19+
20+
- Pull the latest changes from `main` or `stableX`
21+
- Checkout a new branch with the tag name (e.g `v4.0.1`): `git checkout -b v<version>`
22+
- Run `npm version patch --no-git-tag-version` (`npm version minor --no-git-tag-version` if minor).
23+
This will return a new version name, make sure it matches what you expect
24+
- Generate the changelog content from the [release](https://github.com/nextcloud-libraries/nextcloud-upload/releases) page.
25+
Create a draft release, select the previous tag, click `generate` then paste the content to the `CHANGELOG.md` file
26+
1. adjust the links to the merged pull requests and authors so that the changelog also works outside of GitHub
27+
by running `npm run prerelease:format-changelog`.
28+
This will apply this regex: `by @([^ ]+) in ((https://github.com/)nextcloud-libraries/nextcloud-upload/pull/(\d+))`
29+
Which this as the replacement: `[\#$4]($2) \([$1]($3$1)\)`
30+
2. use the the version as tag AND title (e.g `v4.0.1`)
31+
3. add the changelog content as description (https://github.com/nextcloud-libraries/nextcloud-upload/releases)
32+
- Commit, push and create PR
33+
- Get your PR reviewed and merged
34+
- Create a milestone with the follow-up version at https://github.com/nextcloud-libraries/nextcloud-upload/milestones
35+
- Move all open tickets and PRs to the follow-up
36+
- Close the milestone of the version you release
37+
- Publish the previously drafted release on GitHub
38+
![image](https://user-images.githubusercontent.com/14975046/124442568-2a952500-dd7d-11eb-82a2-402f9170231a.png)

build/format-changelog.mjs

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/**
2+
* SPDX-FileCopyrightText: Nextcloud GmbH and Nextcloud contributors
3+
* SPDX-License-Identifier: AGPL-3.0-or-later
4+
*/
5+
import { readFile, writeFile } from 'node:fs/promises'
6+
import { join } from 'node:path'
7+
8+
console.info('🔎 checking format of CHANGELOG.md')
9+
10+
const file = join(import.meta.dirname, '..', 'CHANGELOG.md')
11+
const content = await readFile(file, { encoding: 'utf-8' })
12+
13+
const formatted = content.replaceAll(
14+
/by @([^ ]+) in ((https:\/\/github.com\/)nextcloud-libraries\/nextcloud-upload\/pull\/(\d+))/g,
15+
'[\\#$4]($2) \\([$1]($3$1)\\)',
16+
)
17+
18+
if (formatted !== content) {
19+
console.info('✏️ fixing format')
20+
await writeFile(file, formatted)
21+
console.info('🎉 done')
22+
} else {
23+
console.info('✅ no formatting needed - done.')
24+
}

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@nextcloud/upload",
3-
"version": "1.9.1",
3+
"version": "1.10.0",
44
"description": "Nextcloud file upload client",
55
"keywords": [
66
"nextcloud",
@@ -36,6 +36,7 @@
3636
"scripts": {
3737
"build": "vite --mode production build",
3838
"build:doc": "typedoc --out dist/doc lib && touch dist/doc/.nojekyll",
39+
"prerelease:format-changelog": "node build/format-changelog.mjs",
3940
"cypress": "cypress run --component",
4041
"cypress:gui": "cypress open --component",
4142
"dev": "vite --mode development build",

0 commit comments

Comments
 (0)