@nextcloud/upload

Nextcloud upload helpers for Nextcloud apps

Important

@nextcloud/upload is in maintenance now, so this library will only get bug fixes but no new features. We will keep it working with Nextcloud up to 36 and provide bug fixes until end of 2027. Starting with 2028 this library will be in life-support where we only will provide important security fixes.

Instead please use either the API directly, provided by the @nextcloud/files library or the NcUploadPicker component provided by @nextcloud/vue.

Usage

📘 API documentation

Development

📤 Releasing a new version

• Pull the latest changes from main or stableX
• Checkout a new branch with the tag name (e.g v4.0.1): git checkout -b v<version>
• Run npm version patch --no-git-tag-version (npm version minor --no-git-tag-version if minor). This will return a new version name, make sure it matches what you expect
• Generate the changelog content from the release page. Create a draft release, select the previous tag, click generate then paste the content to the CHANGELOG.md file
  1. adjust the links to the merged pull requests and authors so that the changelog also works outside of GitHub by running npm run prerelease:format-changelog. This will apply this regex: by @([^ ]+) in ((https://github.com/)nextcloud-libraries/nextcloud-upload/pull/(\d+)) Which this as the replacement: [\#$4]($2) \([$1]($3$1)\)
  2. use the the version as tag AND title (e.g v4.0.1)
  3. add the changelog content as description (https://github.com/nextcloud-libraries/nextcloud-upload/releases)
• Commit, push and create PR
• Get your PR reviewed and merged
• Create a milestone with the follow-up version at https://github.com/nextcloud-libraries/nextcloud-upload/milestones
• Move all open tickets and PRs to the follow-up
• Close the milestone of the version you release
• Publish the previously drafted release on GitHub