Skip to content

Release v1.1.0

Latest

Choose a tag to compare

@github-actions github-actions released this 21 Jun 02:58
· 1 commit to main since this release
2ea65ac

footy-data-kit v1.1.0

Summary

  • Expands generated lower-tier data while preserving the top-four-tier contract: tier 5 and level 6 now cover the modern 1979-2025 lower-tier slice where source pages expose usable tables.
  • Grows generated club metadata from 232 to 375 records, reflecting the broader maintained dataset scope.
  • Adds club crest asset metadata with candidate provenance, license classification, generated placeholders, and review flags so consumers can choose an asset policy that matches their rights model.

Breaking Changes

None.

Data Changes

  • Keeps tier1 through tier4 season coverage unchanged from v1.0.0.
  • Expands generated tier5 coverage from 14 to 47 seasons.
  • Expands generated level-six coverage from 5 to 47 seasons, using tier6.divisions[] for parallel divisions.
  • Adds assets.crest bundles to data/club-metadata.json. The package stores URLs and provenance only; it does not download or redistribute image binaries.
  • Classifies crest records as usable, restricted, placeholder, or needs-more-research, with review issues captured in data/club-assets-review.json.
  • Leaves Hounslow as the only true needs-more-research crest/color case, with Bridgend Town, Bromsgrove Rovers, and Solihull Borough still marked for quality review.

Validation

  • Full local release-readiness checks passed before the pre-release branch: pnpm test, pnpm test:integration, pnpm typecheck, pnpm -s verify:data, pnpm -s schema:verify, pnpm format:check, pnpm -s docs:check, pnpm -s lint, and pnpm -s release:dry-run-data.
  • The release dry-run rebuilt the full 1888-2025 generated range into a temporary directory, produced 138 season records and 375 club metadata records, and passed data verification, club-continuity verification, and JSON Schema verification.
  • data/club-metadata-review.json is clean with issueCount: 0.
  • Known club asset review issues are limited to expected restricted-license club marks, one missing research case, and three quality-review candidates.

Consumer Notes

  • trackedFromSeason and trackedToSeason remain observed generated-data bounds, not founded or dissolved dates.
  • status.current remains a current high-level metadata status, not a season-row outcome.
  • Consumers should use usable crest assets by default, include placeholder only when generated fallback shields are acceptable, and include restricted only when their product can handle club mark licensing and trademark restrictions.
  • Treat needs-review, needs-more-research, and failed crest states as non-display states unless the consuming app has its own review workflow.

Known Limitations

  • The lower-tier expansion substantially broadens generated coverage, but it is still constrained by Wikipedia source page availability and structure.
  • Most discovered club marks are license or trademark restricted, so the new crest metadata is a provenance and filtering layer rather than a blanket permission grant.
  • The remaining non-license asset review items are intentionally carried forward rather than filled with weak assertions.

Published Data

  • Season coverage: 1888-2025 (138 season records)
  • League table records: 513 tier tables
  • Club metadata records: 375
  • Club status split: 290 active, 6 historical, 79 unknown
  • Clubs with source-backed lifecycle events: 164
  • Clubs with tracked absence explanations: 125

Data Change Summary

  • Seasons before: 138
  • Seasons after: 138
  • Added seasons: 0
  • Removed seasons: 0
  • Changed seasons: 0

No season-table changes were detected after regenerating the release data.

Validation

Release data is regenerated from the Wikipedia overview pipeline and checked before publishing.

  • Jest unit tests
  • Wikipedia integration tests
  • ESLint
  • Prettier format check
  • FootballData structural validation
  • Club continuity and historical-reason validation
  • Table points-order validation, with known points-per-game and source-order exceptions explicitly exempted

Assets

  • all-seasons.json
  • all-seasons.min.json
  • wiki_overview_tables_by_season.json
  • wiki_overview_tables_by_season.min.json
  • club-metadata.json
  • release-diff.json
  • release-diff.md
  • release-notes.md

The detailed machine diff is attached as release-diff.json; the compact markdown diff is attached as release-diff.md.