diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 0000000000..1d6032d3cb --- /dev/null +++ b/.github/release.yml @@ -0,0 +1,33 @@ +# https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes +changelog: + exclude: + authors: + - dependabot + - dependabot[bot] + - nextcloud-bot + - nextcloud-command + labels: + - automated + - dependencies + - duplicate + - invalid + - l10n + - question + - wontfix + + categories: + - title: 🔐 Security + labels: + - security + - title: 💥 Breaking Changes + labels: + - breaking + - title: 🚀 Enhancements + labels: + - enhancements + - title: 🐛 Fixed bugs + labels: + - bug + - title: Other Changes + labels: + - "*" \ No newline at end of file diff --git a/.github/workflows/changelog-generate.yml b/.github/workflows/changelog-generate.yml deleted file mode 100644 index 19305fe61c..0000000000 --- a/.github/workflows/changelog-generate.yml +++ /dev/null @@ -1,60 +0,0 @@ -name: Changelog - -on: - pull_request: - paths: - - 'package.json' - -jobs: - build: - name: Auto generation - runs-on: ubuntu-latest - steps: - - name: Check-out - uses: actions/checkout@v3 - - - name: Get last released tag - id: last_version - uses: InsonusK/get-latest-release@v1.1.0 - with: - myToken: ${{ secrets.GITHUB_TOKEN }} - exclude_types: draft - view_top: 1 - - # Returns the version without a leading v - - name: Get new version - id: future_version - uses: Saionaro/extract-package-version@v1.2.1 - - - name: Generate changelog between ${{ steps.last_version.outputs.tag_name }} and v${{ steps.future_version.outputs.version }} - uses: docker://ferrarimarco/github-changelog-generator - # If we have a version change - if: steps.last_version.outputs.tag_name != format('{{v{0}}}', steps.future_version.outputs.version) - with: - args: > - -t ${{ secrets.GITHUB_TOKEN }} - --user nextcloud-libraries - --project nextcloud-vue - --no-issues - --no-issues-wo-labels - --max-issues 0 - --exclude-labels "duplicate,question,invalid,wontfix,dependencies" - --since-tag ${{ steps.last_version.outputs.tag_name }} - --future-release v${{ steps.future_version.outputs.version }} - --breaking-label "### :boom: Breaking changes" - --enhancement-label "### :rocket: Enhancements" - --bugs-label "### :bug: Fixed bugs" - --deprecated-label "### Deprecated" - --removed-label "### Removed" - --security-label "### Security fixes" - --issues-label "### Closed issues" - --pr-label "### Closed pull requests" - - - name: Print changelog to console - run: cat CHANGELOG.md - - - name: Upload changelog - uses: actions/upload-artifact@v3 - with: - name: Changelog - path: CHANGELOG.md diff --git a/README.md b/README.md index 5cc8df38ce..ee13c71433 100644 --- a/README.md +++ b/README.md @@ -143,17 +143,20 @@ index 0e3a6a705d..416b8b0fb9 100644 ## Releasing a new version -- Pull the latest changes from `master` or `stableX`; -- Checkout a new branch with the tag name (e.g `v4.0.1`): `git checkout -b v`; -- 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; -- Commit, push and create PR; -- Add the change log content from the 'Changelog' action on GitHub to `CHANGELOG.md`; -- Commit and push; -- Get your PR reviewed and merged; +- Pull the latest changes from `master` or `stableX` +- Checkout a new branch with the tag name (e.g `v4.0.1`): `git checkout -b v` +- 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](https://github.com/nextcloud-libraries/nextcloud-vue/releases) page. + Create a draft release, select the previous tag, click `generate` then paste the content to the `CHANGELOG.md` file + 1. use the the version as tag AND title (e.g `v4.0.1`) + 2. add the changelog content as description (https://github.com/nextcloud-libraries/nextcloud-vue/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-vue/milestones - Move all open tickets and PRs to the follow-up - Close the milestone of the version you release -- Create a release on GitHub with the version as tag (e.g `v4.0.1`) and add the changelog content as description (https://github.com/nextcloud-libraries/nextcloud-vue/releases); +- Publish the previously drafted release on GitHub ![image](https://user-images.githubusercontent.com/14975046/124442568-2a952500-dd7d-11eb-82a2-402f9170231a.png)