From bef1df92b99dbd4e8a7321e1ba70be6149814a46 Mon Sep 17 00:00:00 2001 From: Juan Calderon-Perez <835733+gaby@users.noreply.github.com> Date: Thu, 21 Sep 2023 11:34:34 -0400 Subject: [PATCH] docs: Support for Release Drafter (#1525) --- .github/ISSUE_TEMPLATE/1-bug-report.yaml | 1 + .github/ISSUE_TEMPLATE/2-feature-request.yaml | 1 + .github/ISSUE_TEMPLATE/3-docs-bug.yaml | 1 + .github/dependabot.yml | 12 ++-- .github/release-drafter.yml | 71 +++++++++++++++++++ .github/workflows/release-drafter.yml | 22 ++++++ 6 files changed, 100 insertions(+), 8 deletions(-) create mode 100644 .github/release-drafter.yml create mode 100644 .github/workflows/release-drafter.yml diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.yaml b/.github/ISSUE_TEMPLATE/1-bug-report.yaml index 4ac628c0b8..291ac805fa 100644 --- a/.github/ISSUE_TEMPLATE/1-bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/1-bug-report.yaml @@ -1,5 +1,6 @@ name: Bug Report description: Report a bug in the OpenObserve +labels: ["โ˜ข๏ธ Bug"] body: - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.yaml b/.github/ISSUE_TEMPLATE/2-feature-request.yaml index 7650e1444a..20ad54537c 100644 --- a/.github/ISSUE_TEMPLATE/2-feature-request.yaml +++ b/.github/ISSUE_TEMPLATE/2-feature-request.yaml @@ -1,5 +1,6 @@ name: 'Feature Request' description: Suggest a feature for OpenObserve +labels: ["โœ๏ธ Feature"] body: - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/3-docs-bug.yaml b/.github/ISSUE_TEMPLATE/3-docs-bug.yaml index 54008d2739..4b379a9441 100644 --- a/.github/ISSUE_TEMPLATE/3-docs-bug.yaml +++ b/.github/ISSUE_TEMPLATE/3-docs-bug.yaml @@ -1,5 +1,6 @@ name: 'Docs or https://openobserve.ai/docs/ Bug Report' description: Report an issue in OpenObserve's documentation +labels: ["๐Ÿ“’ Documentation"] body: - type: textarea diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 796a81616e..fdc5bbb2d7 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,12 +1,8 @@ -# To get started with Dependabot version updates, you'll need to specify which -# package ecosystems to update and where the package manifests are located. -# Please see the documentation for all configuration options: -# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates - version: 2 updates: - - package-ecosystem: "" # See documentation for possible values - directory: "/" # Location of package manifests + - package-ecosystem: "github-actions" + directory: "/" schedule: interval: "weekly" - \ No newline at end of file + labels: + - "๐Ÿค– Dependencies" \ No newline at end of file diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml new file mode 100644 index 0000000000..22ac2b5c00 --- /dev/null +++ b/.github/release-drafter.yml @@ -0,0 +1,71 @@ +name-template: '$RESOLVED_VERSION' +tag-template: '$RESOLVED_VERSION' +categories: + - title: 'โ— Breaking Changes:' + labels: + - 'โ— Breaking Change' + - title: '๐Ÿš€ New Features:' + labels: + - 'โœ๏ธ Feature' + - title: '๐Ÿ› Fixes:' + labels: + - 'โ˜ข๏ธ Bug' + - title: '๐Ÿ“š Documentation:' + labels: + - '๐Ÿ“’ Documentation' + - title: '๐Ÿงน Updates:' + collapse-after: 25 + labels: + - '๐Ÿงน Updates' + - '๐Ÿค– Dependencies' +change-template: '- $TITLE (#$NUMBER)' +change-title-escapes: '\<*_&' +exclude-contributors: + - dependabot + - dependabot[bot] +version-resolver: + major: + labels: + - 'โ— Breaking Change' + minor: + labels: + - 'โœ๏ธ Feature' + patch: + labels: + - '๐Ÿ“’ Documentation' + - 'โ˜ข๏ธ Bug' + - '๐Ÿค– Dependencies' + - '๐Ÿงน Updates' + default: patch +template: | + $CHANGES + + ## ๐Ÿณ Docker Images + - `public.ecr.aws/zinclabs/$REPOSITORY:latest` + - `public.ecr.aws/zinclabs/$REPOSITORY:latest-simd` + - `public.ecr.aws/zinclabs/$REPOSITORY:$RESOLVED_VERSION` + - `public.ecr.aws/zinclabs/$REPOSITORY:$RESOLVED_VERSION-simd` + + **๐Ÿ“’ Documentation**: https://openobserve.ai/docs/ + + **Full Changelog**: https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...$RESOLVED_VERSION + + Thanks to $CONTRIBUTORS for making this release possible. +autolabeler: +- label: '๐Ÿ“’ Documentation' + files: + - '*.md' + title: + - '/(docs|doc:|\[doc\]|typos|comment|documentation)/i' +- label: 'โ˜ข๏ธ Bug' + title: + - '/(fix|race|bug|missing|correct)/i' +- label: '๐Ÿงน Updates' + title: + - '/(improve|update|update|refactor|deprecated|remove|unused|test)/i' +- label: '๐Ÿค– Dependencies' + title: + - '/(bump|dependencies)/i' +- label: 'โœ๏ธ Feature' + title: + - '/(feature|feat|create|implement|add)/i' \ No newline at end of file diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml new file mode 100644 index 0000000000..a269770177 --- /dev/null +++ b/.github/workflows/release-drafter.yml @@ -0,0 +1,22 @@ +name: Release Drafter + +on: + push: + branches: + - main + pull_request_target: + types: [opened, reopened, synchronize] + +permissions: + contents: read + +jobs: + update_release_draft: + permissions: + contents: write + pull-requests: write + runs-on: ubuntu-latest + steps: + - uses: release-drafter/release-drafter@v5 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file