Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci(docs): 👷 update docs ci with mkdocs-insiders and use uv #140

Merged
merged 2 commits into from
Feb 5, 2025

Conversation

onuralpszr
Copy link
Collaborator

## Description

This PR enable us to use mkdocs-insiders

Changes to .github/workflows/publish-release-docs.yml:

  • Renamed the workflow to "Build and Publish Docs" and added triggers for push events on the develop branch and for release events.
  • Updated permissions to specify required access for contents, pages, and pull-requests.
  • Renamed the job to deploy and added a timeout of 10 minutes.
  • Updated steps to include setting up dependencies with uv and creating a GitHub App token for mkdocs.
  • Added separate steps for deploying development and release documentation based on event conditions.

Changes to .github/workflows/test-doc.yml:

  • Renamed the workflow to "🧪 Docs Test WorkFlow 📚".
  • Added an environment configuration for the docs-build-test job, specifying the name and URL.
  • Updated steps to include setting up dependencies with uv and creating a GitHub App token for mkdocs.
  • Modified the Test Docs Build step to use uv for running the mkdocs build command.

@onuralpszr onuralpszr added the documentation Improvements or additions to documentation label Feb 5, 2025
@onuralpszr onuralpszr self-assigned this Feb 5, 2025
@onuralpszr onuralpszr temporarily deployed to documentation-develop February 5, 2025 19:27 — with GitHub Actions Inactive
@onuralpszr onuralpszr force-pushed the docs/mkdocs-insiders branch from a5f7d81 to 87648ad Compare February 5, 2025 19:32
@onuralpszr onuralpszr force-pushed the docs/mkdocs-insiders branch from 87648ad to 442be6b Compare February 5, 2025 19:33
@onuralpszr onuralpszr merged commit 908e274 into develop Feb 5, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant