Skip to content

Prepare markdown-blog for public release on Packagist - #3

Merged
mwamodo merged 3 commits into
masterfrom
turbine
Aug 18, 2026
Merged

mwamodo merged 3 commits into
masterfrom
turbine

Conversation

@mwamodo

@mwamodo mwamodo commented Aug 18, 2026

Copy link
Copy Markdown
Member

Prepares the package for its public Packagist listing as apxcde/markdown-blog.

Synced from the Turbine monorepo (upstream issue: "Publish apxcde/markdown-blog to Packagist").

What changed

  • LICENSE.md — full MIT text, holder ApexCode. Canonical MIT wording, so the only difference from the copy already on master is the holder line (XSAVOApexCode).
  • composer.json"license": "MIT", plus publishable metadata for the Packagist page: keywords, homepage, authors, and a support block pointing issues and source at this repository.
  • README.md — rewritten on the apxcde identity: installs via composer require apxcde/markdown-blog, apxcde\MarkdownBlog\... namespaces throughout, and an accurate reference for the config keys, frontmatter handling, API, and returned article shape.
  • phpstan.neon.dist — drops the database path. This is a port-back: the change already exists on master but had never landed upstream, so without it the next sync would have reintroduced the broken path here.

Verification

  • Package suite green: 8 passed (33 assertions). Full monorepo platform suite green: 400 passed.
  • composer validate./composer.json is valid.
  • Every behavioural claim in the README was executed against the package rather than read off the source, including the frontmatter fallbacks, formatted_date being null when undated and falling back to the raw string when unparseable, findBySlug slug normalisation, recursive discovery, and descending date sort with undated articles last.
  • The frontmatter section documents what the parser actually does with unsupported YAML: nested keys are hoisted to the top level, - item lines are dropped, - name: foo yields a literal - name key, and [a, b] is kept as a raw string. These are quietly mis-read rather than ignored, so the README now says so.

Merge note

master and turbine both modified LICENSE.md, README.md, composer.json, and phpstan.neon.dist since the merge base (49b5dfd), so this will report conflicts. Resolve by taking the turbine side on all four — they are strictly newer, and phpstan.neon.dist is already byte-identical to master.

.github/workflows/tests.yml is master-only and untouched here; CI is unaffected.

Not included

Tagging a release, submitting to packagist.org, and enabling the update webhook remain manual follow-ups.

…lease

- Update LICENSE.md to full MIT text and composer.json metadata (license,
  authors, keywords, support links) for the apxcde/markdown-blog Packagist
  release
- Rewrite README to reflect the new package name, document frontmatter
  fallback/parsing behavior in detail, and add contributing/license sections
- Drop the unused `database` path from phpstan analysis paths
@mwamodo

mwamodo commented Aug 18, 2026

Copy link
Copy Markdown
Member Author

@copilot resolve the merge conflicts in this pull request take the turbine side on all four files

Copilot AI and others added 2 commits August 18, 2026 14:50
Co-authored-by: mwamodo <52991058+mwamodo@users.noreply.github.com>
Co-authored-by: mwamodo <52991058+mwamodo@users.noreply.github.com>

Copilot AI commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

@copilot resolve the merge conflicts in this pull request take the turbine side on all four files

Done in 190e2c7: merged master into turbine and resolved conflicts by taking the turbine side for LICENSE.md, README.md, composer.json, and phpstan.neon.dist. Also added a follow-up hardening commit bf48bab for explicit workflow token permissions required by CodeQL.

@mwamodo
mwamodo merged commit eb2d0fa into master Aug 18, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants