Skip to content

Commit 0198bad

Browse files
cursoragentkhnumdev
andcommitted
Update README with config guidance and publishing workflow details
Co-authored-by: isisosirishorus <[email protected]>
1 parent fbf5abb commit 0198bad

File tree

2 files changed

+7
-38
lines changed

2 files changed

+7
-38
lines changed

README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ pip install -e .
2323

2424
## Configuration
2525

26-
- By default, the CLI loads `config.yaml` from the current directory if present.
26+
- Create a local `config.yaml` in your working directory. It is gitignored and not included in the repo.
2727
- Any CLI flag overrides values from `config.yaml`.
2828
- If neither config nor flags provide a value, the tool falls back to environment variables (for emulator detection) or sensible defaults.
2929

30-
Key settings in `config.yaml`:
30+
Example `config.yaml`:
3131

3232
```yaml
3333
project_id: "my-project" # If omitted, ADC/env will be used
@@ -93,13 +93,9 @@ black .
9393

9494
## Publishing
9595

96-
- CI is configured to publish to PyPI on tags `v*`.
97-
- Create a PyPI token and add it to repository secrets as `PYPI_API_TOKEN`.
98-
- Tag and push:
96+
- Automated: pushing to `main` triggers versioning, tagging, GitHub release, and PyPI publish via semantic-release.
97+
- Prerequisites:
98+
- Add a PyPI token to repo secrets as `PYPI_API_TOKEN`.
99+
- Use conventional commits for proper versioning.
99100

100-
```bash
101-
git tag v0.1.0
102-
git push origin v0.1.0
103-
```
104-
105-
The GitHub Actions workflow will build and upload the package to PyPI.
101+
Main branch should be protected (require PRs, disallow direct pushes) in repository settings.

config.yaml

Lines changed: 0 additions & 27 deletions
This file was deleted.

0 commit comments

Comments
 (0)