Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ updates:
actions:
patterns:
- "*"
commit-message:
prefix: "chore"

- package-ecosystem: "pip"
directory: "/"
Expand All @@ -25,3 +27,5 @@ updates:
ignore:
- dependency-name: "pydantic"
versions: [">=2.0"]
commit-message:
prefix: "chore"
15 changes: 15 additions & 0 deletions .github/workflows/pr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: PR Conventional Commit Validation

on:
pull_request:
types: [opened, synchronize, reopened, edited]

jobs:
validate-pr-title:
runs-on: ubuntu-latest
steps:
- name: PR Conventional Commit Validation
uses: ytanikin/[email protected]
with:
task_types: '["feat","fix","docs","test","ci","refactor","perf","chore","revert"]'
add_label: 'false'
25 changes: 25 additions & 0 deletions docs/explanations/decisions/0006-conventional-commits.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# 3. Short descriptive title

Date: 2025-04-15

## Status

Accepted

## Context

Blueapi publishes not only the library code but also a containerised service & helm chart.
Each of the published artifacts are in flux and in periods of adoption, where new users may adopt its use amidst major version changes.
To give some certainty to users, we should document changes and highlight important ones.
As dependency management becomes more automated, we should ensure that semantic versioning is used accurately, and make allowances for automation.

## Decision

Commits to the default branch of the copier template should be made using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), and the Conventional Commit standard should be used to identify the next released version and create changelogs/release notes.

## Consequences

A [GitHub Action](https://github.com/ytanikin/PRConventionalCommits) has been configured to ensure that PRs may not be merged without being in the form of a Conventional Commit.
PRs will be squash-and-merged, with the complete git history of the change preserved in the PR but only a single commit on the default branch.
PR commit messages will be taken from the title and body of the PR, ensuring that the commit will be compatible with the standard.
Tooling (dependabot etc.) will be configured to make compatible PRs.
Loading