Merge pull request #52 from github/jm-automated-releases

feat: add automated release and labelling

.github/auto-labeler.yml

@@ -0,0 +1,22 @@
+autolabeler:
+  - label: 'automation'
+    title:
+      - '/^(build|ci|perf|refactor|test).*/i'
+  - label: 'enhancement'
+    title:
+      - '/^(chore|style).*/i'
+  - label: 'documentation'
+    title:
+      - '/^docs.*/i'
+  - label: 'feature'
+    title:
+      - '/^feat.*/i'
+  - label: 'fix'
+    title:
+      - '/^fix.*/i'
+  - label: 'infrastructure'
+    title:
+      - '/^infrastructure.*/i'
+  - label: 'revert'
+    title:
+      - '/^revert.*/i'

.github/pull_request_template.md

@@ -1,5 +1,12 @@
 # Pull Request
-<!-- PR title should be brief and descriptive for a good changelog entry -->
+<!-- 
+PR title needs to be prefixed with a conventional commit type
+(build,chore,ci,docs,feat,fix,perf,refactor,revert,style,test)
+
+It should also be brief and descriptive for a good changelog entry
+
+examples: "feat: add new logger" or "fix: remove unused imports"
+-->
 
 ## Proposed Changes
 <!-- Describe what the changes are and link to a GitHub Issue if one exists -->

.github/release-drafter.yml

@@ -4,9 +4,9 @@ tag-template: 'v$RESOLVED_VERSION'
 template: |
   # Changelog
   $CHANGES
-  
-  See details of [all code changes](https://github.com/github/cleanowners/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION) since previous release 
-  
+
+  See details of [all code changes](https://github.com/github/cleanowners/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION) since previous release
+
 categories:
   - title: '🚀 Features'
     labels:
@@ -23,6 +23,7 @@ categories:
       - 'automation'
       - 'documentation'
       - 'dependencies'
+      - 'revert'
   - title: '🏎 Performance'
     label: 'performance'
 change-template: '- $TITLE @$AUTHOR (#$NUMBER)'

.github/workflows/auto-labeler.yml

@@ -0,0 +1,28 @@
+---
+  name: Auto Labeler
+
+  on:
+    # pull_request event is required only for autolabeler
+    pull_request:
+      # Only following types are handled by the action, but one can default to all as well
+      types: [opened, reopened, synchronize]
+    # pull_request_target event is required for autolabeler to support PRs from forks
+    pull_request_target:
+      types: [opened, reopened, synchronize]
+
+  permissions:
+    contents: read
+
+  jobs:
+    main:
+      permissions:
+        contents: write
+        pull-requests: write
+      name: Auto label pull requests
+      runs-on: ubuntu-latest
+      steps:
+        - uses: release-drafter/release-drafter@v6
+          env:
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          with:
+            config-name: auto-labeler.yml

.github/workflows/pr-title.yml

@@ -0,0 +1,41 @@
+## Reference: https://github.com/amannn/action-semantic-pull-request
+---
+name: "Lint PR"
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+permissions:
+  contents: read
+
+jobs:
+  main:
+    permissions:
+      pull-requests: read
+      statuses: write
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          # Configure which types are allowed (newline-delimited).
+          # From: https://github.com/commitizen/conventional-commit-types/blob/master/index.json
+          # listing all below
+          types: |
+            build
+            chore
+            ci
+            docs
+            feat
+            fix
+            perf
+            refactor
+            revert
+            style
+            test

.github/workflows/release.yml

@@ -0,0 +1,64 @@
+---
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  create_release:
+    outputs:
+      full-tag: ${{ steps.release-drafter.outputs.tag_name }}
+      short-tag: ${{ steps.get_tag_name.outputs.SHORT_TAG }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: read
+    steps:
+      - uses: release-drafter/release-drafter@v6
+        id: release-drafter
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          config-name: release-drafter.yml
+          publish: true
+      - name: Get the short tag
+        id: get_tag_name
+        run: |
+          short-tag=$(echo ${{ steps.release-drafter.outputs.tag_name }} | cut -d. -f1)
+          echo "SHORT_TAG=$short-tag" >> $GITHUB_OUTPUT
+  create_action_images:
+    needs: create_release
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+    env:
+      REGISTRY: ghcr.io
+      IMAGE_NAME: ${{ github.repository }}
+    steps:
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Log in to the Container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Push Docker Image
+        if: ${{ success() }}
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./Dockerfile
+          push: true
+          tags: |
+            ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest
+            ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ needs.create_release.outputs.full-tag }}
+            ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ needs.create_release.outputs.short-tag }}
+          platforms: linux/amd64,linux/arm64
+          provenance: false
+          sbom: false

CONTRIBUTING.md

@@ -55,7 +55,7 @@ A good bug report shouldn't leave others needing to chase you up for more inform
 
 We use GitHub issues to track bugs and errors. If you run into an issue with the project:
 
-- Open an [Issue](https://github.com/github/cleanowners/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
+- Open an [Issue](https://github.com/github/cleanowners/issues/new).
 - Explain the behavior you would expect and the actual behavior.
 - Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
 - Provide the information you collected in the previous section.
@@ -89,6 +89,10 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/github
 - You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to.
 - **Explain why this enhancement would be useful** to most cleanowners users.
 
+### Pull Request Standards
+
+We are using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) to standardize our pull request titles. This allows us to automatically generate labels and changelogs and follow semantic versioning. Please follow the commit message format when creating a pull request. What pull request title prefixes are expected are in the [pull_request_template.md](.github/pull_request_template.md) that is shown when creating a pull request.
+
 ## Releases
 
 To release a new version, maintainers are to release new versions following semantic versioning and via GitHub Releases.