Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions CI.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# CI and Security
# CI

| Workflow | Runs on | Purpose |
| ------------------------------------------------- | ---------------------------- | ---------------------------------------------- |
Expand All @@ -16,7 +16,6 @@
a deploy key, and publishes the GitHub Release. `publish-pypi` then uploads the same build to
PyPI with trusted publishing, from the `pypi` environment. See [RELEASE.md](RELEASE.md) for the
settings it needs
* GitHub Actions are pinned to full commit SHAs, with the version in a trailing comment
* Dependabot (`.github/dependabot.yml`) checks weekly for updates to GitHub Actions and Python
dependencies, and monthly for the dev container image and dev container features. New releases
wait 7 days before an update is proposed. Dependabot PRs get the `dependencies` label
13 changes: 3 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@ Project supports local development and VSCode Dev container development

### Local Development Installation

Note: Project uses `uv` (0.13.x, enforced by `required-version` in `pyproject.toml`) and `just` to
manage project configuration and commands
Note: Project uses `uv` and `just` to manage project configuration and commands

* Install `just` - `brew install just`
* Set up project - `just setup`
Expand Down Expand Up @@ -57,7 +56,7 @@ manage project configuration and commands
* `just test`
* `gitleaks` secret scan of staged changes

## CI and Security
## CI

See [CI.md](https://github.com/ahcodedev/pypricecharting/blob/main/CI.md) for the GitHub Actions workflows and Dependabot setup.

Expand Down Expand Up @@ -102,15 +101,9 @@ Project contains an OpenAPI spec and a Bruno project for easy testing and mockin

## TODO / Investigate

None of the client methods have been run against the live API yet. They are tested against a mock
transport and the two specs only. Items to settle with real responses:

* **Offer details price limits** - `OfferDetailsResponse` reads `price-max` and `price-min`, the
names in the documentation's key table. If the API sends `max-price` and `min-price` instead,
`price_max` and `price_min` come back as `None` with no error. Check one real
`/api/offer-details` response
`price_max` and `price_min` come back as `None` with no error. Validate `/api/offer-details`
* **Extra Marketplace keys** - `pending-reason`, `seller-id`, `image-url`, `best-competing-price`,
`is-best-priced-offer` and `value` are only on `OfferDetailsResponse`. The documentation doesn't
say which endpoint returns each one. If `/api/offers` returns any of them, add them to `Offer`
* **Live test of every endpoint** - call each method once with a real token and compare the
response to its model
17 changes: 0 additions & 17 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,22 +26,5 @@ labels; other repository labels (e.g. `good first issue`, `question`) are ignore
`pyproject.toml`/`uv.lock`, builds the package, tags and publishes the GitHub Release with the
build attached, then publishes the same build to [PyPI](https://pypi.org/project/pypricecharting/).
The GitHub Release notes are the changelog
* The workflow regenerates the draft's notes when it starts, so edit the notes after the release
is published, not before
* The version bump is committed as `Release vX.Y.Z` and pushed straight to `main`, with no PR.
The tag points at that commit
* The first release must resolve to a version above the `0.0.1` in `pyproject.toml`, or the
commit step fails with nothing to commit

## Release setup

The Release workflow depends on these settings outside the repository files:

* **Deploy key**: the release commit is pushed over SSH with a write-access deploy key. Its
private half is the `RELEASE_DEPLOY_KEY` Actions secret. If `main` has a ruleset that requires
pull requests or status checks, **Deploy keys** must be on its bypass list
* **PyPI trusted publisher**: PyPI trusts owner `ahcodedev`, repository `pypricecharting`,
workflow `release.yml`, and environment `pypi`. No PyPI token is stored. Renaming the workflow
file or the environment breaks publishing until PyPI is updated
* **`pypi` environment**: the `publish-pypi` job runs in the `pypi` GitHub environment. If it has
required reviewers, the PyPI upload waits for approval after the GitHub Release is published
Loading