Skip to content

Commit 4151e21

Browse files
committed
Update docs
1 parent 84b1192 commit 4151e21

2 files changed

Lines changed: 28 additions & 4 deletions

File tree

docs/semantic-release.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Reusable workflow that runs [semantic-release](https://github.com/semantic-relea
44

55
## Inputs
66

7-
| Input | Required | Default | Description |
7+
| Input | Required | Default | Description |
88
|----------------|----------|---------|----------------------------|
99
| `node-version` | No | `'24'` | Node.js version to use. |
1010

@@ -41,7 +41,7 @@ module.exports = {
4141
"branches": ["main"],
4242
"tagFormat": "${version}",
4343
"preset": "angular",
44-
"repositoryUrl": "https://github.com/Health-Informatics-UoN/nuh-helper.git",
44+
"repositoryUrl": "https://github.com/Health-Informatics-UoN/[REPO_NAME].git",
4545
plugins: [
4646
'@semantic-release/commit-analyzer',
4747
'@semantic-release/release-notes-generator',
@@ -51,3 +51,27 @@ module.exports = {
5151
"initialVersion": "0.0.1"
5252
};
5353
```
54+
55+
## Python Configuration
56+
57+
In `pyproject.toml` use `hatch-vcs` for a dynamic version.
58+
59+
```toml copy
60+
dynamic = ["version"]
61+
62+
[build-system]
63+
requires = ["hatchling", "hatch-vcs"]
64+
build-backend = "hatchling.build"
65+
66+
[tool.hatch.version]
67+
source = "vcs"
68+
69+
```
70+
71+
## C# Configuration
72+
73+
TODO
74+
75+
## Javascript Configuration
76+
77+
TODO

release.config.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@ module.exports = {
22
"branches": ["main"],
33
"tagFormat": "${version}",
44
"preset": "angular",
5-
"repositoryUrl": "https://github.com/Health-Informatics-UoN/nuh-helper.git",
5+
"repositoryUrl": "https://github.com/Health-Informatics-UoN/workflows.git",
66
plugins: [
77
'@semantic-release/commit-analyzer',
88
'@semantic-release/release-notes-generator',
99
'@semantic-release/exec',
1010
'@semantic-release/github',
1111
],
12-
"initialVersion": "0.0.1"
12+
"initialVersion": "1.0.0"
1313
};

0 commit comments

Comments
 (0)