Skip to content

docs: add versioning with mike#1334

Merged
michalsn merged 2 commits into
codeigniter4:developfrom
michalsn:feat/docs-versioning
Jun 5, 2026
Merged

docs: add versioning with mike#1334
michalsn merged 2 commits into
codeigniter4:developfrom
michalsn:feat/docs-versioning

Conversation

@michalsn
Copy link
Copy Markdown
Member

@michalsn michalsn commented Jun 3, 2026

Description
This PR adds docs versioning using mike, published to the gh-pages branch.

Deploy rules

  • Push to develop: deploys the dev docs (work-in-progress)
  • Push a vX.Y.Z tag (e.g. v1.4.0): deploys docs under <major>.<minor> (e.g. 1.4), updates the latest alias, and sets it as the default version (site root redirects here)
  • Pre-release tags (e.g. v1.4.0-rc1): are skipped

Checklist:

  • Securely signed commits
  • Component(s) with PHPDoc blocks, only if necessary or adds value
  • Unit testing, with >80% coverage
  • User guide updated
  • Conforms to style guide

@michalsn michalsn force-pushed the feat/docs-versioning branch from 57205ec to 2381374 Compare June 3, 2026 19:57
@datamweb datamweb added the github_actions Pull requests that update GitHub Actions code label Jun 3, 2026
Copy link
Copy Markdown
Collaborator

@datamweb datamweb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If possible, could you please update this file as well?

https://github.com/codeigniter4/shield/blob/develop/admin/how_to_build_docs.md

Comment thread docs/CNAME Outdated
Copy link
Copy Markdown
Collaborator

@datamweb datamweb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please rebase this PR to resolve the conflicts?

@michalsn michalsn force-pushed the feat/docs-versioning branch from 4bc5e1f to c88de7f Compare June 4, 2026 18:00
Copy link
Copy Markdown
Collaborator

@datamweb datamweb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @michalsn!

@michalsn michalsn merged commit 9d6e1e5 into codeigniter4:develop Jun 5, 2026
2 checks passed
@michalsn
Copy link
Copy Markdown
Member Author

michalsn commented Jun 5, 2026

Thank you @datamweb

@michalsn michalsn deleted the feat/docs-versioning branch June 5, 2026 07:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

github_actions Pull requests that update GitHub Actions code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants