Skip to content

Commit db1c36b

Browse files
committed
chore: improve release setup
1 parent 0fab321 commit db1c36b

3 files changed

Lines changed: 15 additions & 7 deletions

File tree

.releaserc.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,6 @@ plugins:
7272
- - "@semantic-release/git"
7373
- assets:
7474
- pyproject.toml
75-
message: "chore(release): ${nextRelease.version}"
75+
message: "chore(release mloda-plugin-template): ${nextRelease.version}"
7676

7777
repositoryUrl: "https://github.com/mloda-ai/mloda-plugin-template"

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,14 @@ Edit the following fields in `pyproject.toml`:
6262
- `tool.setuptools.packages.find.include`: Change `["placeholder*"]` to `["acme*"]`
6363
- `tool.pytest.ini_options.testpaths`: Change `["placeholder", "tests"]` to `["acme", "tests"]`
6464

65-
#### 3. Update Python imports
65+
#### 3. Update .releaserc.yaml
66+
67+
Edit the following fields in `.releaserc.yaml`:
68+
69+
- `message`: Change `mloda-plugin-template` to your package name (e.g., `"chore(release acme-my-plugin): ${nextRelease.version}"`)
70+
- `repositoryUrl`: Change to your repository URL
71+
72+
#### 4. Update Python imports
6673

6774
Update imports in these files (change `from placeholder.` to `from acme.`):
6875

@@ -73,10 +80,10 @@ Update imports in these files (change `from placeholder.` to `from acme.`):
7380
- `acme/extenders/my_plugin/__init__.py`
7481
- `acme/extenders/my_plugin/tests/test_my_extender.py`
7582

76-
#### 4. Verify setup
83+
#### 5. Verify setup
7784

7885
```bash
79-
uv venv && source .venv/bin/activate && uv pip install -e ".[dev]" && tox
86+
uv venv && source .venv/bin/activate && uv sync --all-extras && tox
8087
```
8188

8289
### Development Setup with uv
@@ -90,7 +97,7 @@ curl -LsSf https://astral.sh/uv/install.sh | sh
9097
```bash
9198
uv venv
9299
source .venv/bin/activate
93-
uv pip install -e ".[dev]"
100+
uv sync --all-extras
94101
```
95102

96103
**Run all checks with tox:**

docs/getting-started.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,5 +46,6 @@ Regardless of which option you chose, follow the setup steps in the [README](../
4646
1. Clone your new repository locally
4747
2. Rename the `placeholder/` directory
4848
3. Update `pyproject.toml`
49-
4. Update Python imports
50-
5. Verify with `tox`
49+
4. Update `.releaserc.yaml` (change `mloda-plugin-template` to your package name and update `repositoryUrl`)
50+
5. Update Python imports
51+
6. Verify with `tox`

0 commit comments

Comments
 (0)