#

# Format

#

# ACTION: [AUDIENCE:] COMMIT_MSG [@TAG ...]

#

# Description

#

# ACTION is one of 'chg', 'fix', 'new'

#

# Is WHAT the change is about.

#

# 'chg' is for refactor, small improvement, cosmetic changes...

# 'fix' is for bug fixes

# 'new' is for new features, big improvement

#

# SUBJECT is optional and one of 'dev', 'usr', 'pkg', 'test', 'doc'

#

# Is WHO is concerned by the change.

#

# 'dev' is for developpers (API changes, refactors...)

# 'usr' is for final users (UI changes)

# 'pkg' is for packagers (packaging changes)

# 'test' is for testers (test only related changes)

# 'doc' is for doc guys (doc only changes)

#

# COMMIT_MSG is ... well ... the commit message itself.

#

# TAGs are additionnal adjective as 'refactor' 'minor' 'cosmetic'

#

# 'refactor' is obviously for refactoring code only

# 'minor' is for a very meaningless change (a typo, adding a comment)

# 'cosmetic' is for cosmetic driven change (re-indentation, 80-col...)

#

# Example:

#

# new: usr: support of bazaar implemented

# chg: re-indentend some lines @cosmetic

# new: dev: updated code to be compatible with last version of killer lib.

# fix: pkg: updated year of licence coverage.

# new: test: added a bunch of test around user usability of feature X.

# fix: typo in spelling my name in comment. @minor

#

# Please note that multi-line commit message are supported, and only the

# first line will be considered as the "summary" of the commit message. So

# tags, and other rules only applies to the summary. The body of the commit

# message will be displayed in the changelog with minor reformating.

#

# ``ignore_regexps`` is a line of regexps

#

# Any commit having its full commit message matching any regexp listed here

# will be ignored and won't be reported in the changelog.

#

ignore_regexps = [

r'(?i)^(Merge pull request|Merge branch|Release|Update)',

]

#

# ``replace_regexps`` is a dict associating a regexp pattern and its replacement

#

# It will be applied to get the summary line from the full commit message.

#

# Note that you can provide multiple replacement patterns, they will be all

# tried. If None matches, the summary line will be the full commit message.

#

replace_regexps = {

# current format (ie: 'chg: dev: my commit msg @tag1 @tag2')

r'^([cC]hg|[fF]ix|[nN]ew)\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n@]*)(@[a-z]+\s+)*$':

r'\4',

}

# ``section_regexps`` is a list of 2-tuples associating a string label and a

# list of regexp

#

# Commit messages will be classified in sections thanks to this. Section

# titles are the label, and a commit is classified under this section if any

# of the regexps associated is matching.

#

section_regexps = [

('New', [

r'^[nN]ew\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',

]),

('Changes', [

r'^[cC]hg\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',

]),

('Fix', [

r'^[fF]ix\s*:\s*((dev|use?r|pkg|test|doc)\s*:\s*)?([^\n]*)$',

]),

('Other', None # Match all lines

),

]

# ``body_split_regexp`` is a regexp

#

# Commit message body (not the summary) if existing will be split

# (new line) on this regexp

#

body_split_regexp = r'[\n-]'

# ``tag_filter_regexp`` is a regexp

#

# Tags that will be used for the changelog must match this regexp.

#

# tag_filter_regexp = r'^[0-9]+$'

tag_filter_regexp = r'^(?:[vV])?[0-9\.]+$'

# ``unreleased_version_label`` is a string

#

# This label will be used as the changelog Title of the last set of changes

# between last valid tag and HEAD if any.

unreleased_version_label = "%%version%% (unreleased)"

version: 2

updates:

- package-ecosystem: pip

directory: "/"

schedule:

interval: daily

time: "13:00"

groups:

python-packages:

patterns:

- "*"

name: automatic-release

on:

workflow_dispatch:

inputs:

release_type:

description: Release type

required: true

type: choice

options:

- patch

- minor

- major

jobs:

release:

name: Release

runs-on: ubuntu-22.04

steps:

- name: Checkout repository

uses: actions/checkout@v4

with:

fetch-depth: 0

ssh-key: ${{ secrets.DEPLOY_PRIVATE_KEY }}

- name: Setup Git

run: |

- name: Setup Python

uses: actions/setup-python@v4

with:

python-version: '3.8'

- name: Install prerequisites

run: pip install -r release-requirements.txt

- name: Execute release

env:

SEMVER_BUMP: ${{ github.event.inputs.release_type }}

TWINE_REPOSITORY: ${{ vars.TWINE_REPOSITORY }}

TWINE_USERNAME: ${{ secrets.TWINE_USERNAME }}

TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}

run: ./release $SEMVER_BUMP

name: Create and publish a Docker image

on:

push:

branches:

- 'master'

- 'main'

- 'dev'

tags:

- 'v*'

- 'v*.*'

- 'v*.*.*'

- '*'

- '*.*'

- '*.*.*'

pull_request:

branches:

- 'main'

- 'dev'

env:

REGISTRY: ghcr.io

IMAGE_NAME: ${{ github.repository }}

jobs:

build-and-push-image:

runs-on: ubuntu-latest

permissions:

contents: read

packages: write

steps:

- name: Checkout repository

uses: actions/checkout@v3

- name: Set up QEMU

uses: docker/setup-qemu-action@v2

- name: Set up Docker Buildx

uses: docker/setup-buildx-action@v2

- name: Log in to the Container registry

uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9

with:

registry: ${{ env.REGISTRY }}

username: ${{ github.actor }}

password: ${{ secrets.GITHUB_TOKEN }}

- name: Extract metadata (tags, labels) for Docker

id: meta

uses: docker/metadata-action@v4

with:

images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}

tags: |

- name: Build and push Docker image

uses: docker/build-push-action@v4

with:

context: .

push: true

platforms: linux/amd64,linux/arm64

tags: ${{ steps.meta.outputs.tags }}

labels: ${{ steps.meta.outputs.labels }}

---

name: "lint"

on:

pull_request:

branches:

- "*"

push:

branches:

- "main"

- "master"

jobs:

lint:

name: lint

runs-on: ubuntu-22.04

steps:

- name: Checkout repository

uses: actions/checkout@v4

with:

fetch-depth: 0

- name: Setup Python

uses: actions/setup-python@v4

with:

python-version: "3.8"

cache: "pip"

- run: pip install -r release-requirements.txt && pip install wheel

- run: flake8 --ignore=E501,E203,W503

- run: black .

- run: rst-lint README.rst

- run: python setup.py sdist bdist_wheel && twine check dist/*

---

name: "tagged-release"

on:

push:

tags:

- '*'

jobs:

tagged-release:

name: tagged-release

runs-on: ubuntu-20.04

steps:

- uses: "marvinpinto/[email protected]"

with:

repo_token: "${{ secrets.GITHUB_TOKEN }}"

prerelease: false

debian/python-github-backup*

doc/github_backup.1