Skip to content

Commit a096346

Browse files
authored
docs: Add Python steps (#15)
1 parent 3bf7737 commit a096346

2 files changed

Lines changed: 23 additions & 0 deletions

File tree

docs/samples/release.container.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ The idea is to provide a drop-in model for releasing software, where developers
66

77
This exists within the existing constraints of Github, mostly that [automated releases cannot trigger other workflows](https://github.com/orgs/community/discussions/25281), so by composing reusable workflows together we can achieve a full release pipeline that is still easy to understand and maintain. The workflow is also designed to be flexible, so you can easily swap out the container publishing step for other types of release artifacts if needed.
88

9+
Currently only Python is supported, with the intention to provide C# and Typescript soon.
10+
911
## Overview
1012

1113
The workflow performs the following steps:
@@ -21,6 +23,7 @@ The workflow performs the following steps:
2123
- Your repository settings should only allow squash merges, and use the PR title as the commit message for commit messages to be correctly parsed by semantic-release
2224
- You need a `samples/release.config.js` in your repository root to configure semantic-release
2325
- You need a `Dockerfile` in your repository root (or update the `dockerfile` parameter)
26+
- You need to follow the relevant language steps
2427

2528
## Workflow Jobs
2629

@@ -72,6 +75,12 @@ uses: health-informatics-uon/workflows/.github/workflows/semantic-release.yml@v1
7275
7376
Check the [releases](https://github.com/health-informatics-uon/workflows/releases) for available versions.
7477
78+
## Languages
79+
80+
### Python
81+
82+
Follow the `samples/pyproject.toml` sample.
83+
7584
## Usage
7685

7786
1. Copy `samples/release.container.yaml` to your repository's `.github/workflows/release.yaml`

samples/pyproject.toml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
[project]
2+
name = "sample"
3+
4+
# Makes the version dynamic
5+
dynamic = ["version"]
6+
7+
# Adds the hatch-vcs dependency
8+
[build-system]
9+
requires = ["hatchling", "hatch-vcs"]
10+
build-backend = "hatchling.build"
11+
12+
# Sources the version from version control
13+
[tool.hatch.version]
14+
source = "vcs"

0 commit comments

Comments
 (0)