[PR #824] [MERGED] Added support for an alternative current dir mode in pkldoc #760

New Issue

adam · 2025-12-30T01:26:34+01:00

adam commented

2025-12-30 01:26:34 +01:00

📋 Pull Request Information

Original PR: https://github.com/apple/pkl/pull/824
Author: @netvl
Created: 11/19/2024
Status: ✅ Merged
Merged: 2/19/2025
Merged by: @bioball

Base: main ← Head: current-publishing-variants

📝 Commits (2)

c64f5ec Added an ability to avoid creating symlinks in Pkldoc
2e475d9 Adjust test and documentation

📊 Changes

11 files changed (+143 additions, -19 deletions)

View changed files

📝 docs/modules/pkl-doc/pages/index.adoc (+9 -1)
📝 docs/modules/pkl-gradle/pages/index.adoc (+11 -0)
📝 pkl-commons/src/main/kotlin/org/pkl/commons/Paths.kt (+16 -0)
📝 pkl-doc/src/main/kotlin/org/pkl/doc/CliDocGenerator.kt (+1 -0)
📝 pkl-doc/src/main/kotlin/org/pkl/doc/CliDocGeneratorOptions.kt (+11 -0)
📝 pkl-doc/src/main/kotlin/org/pkl/doc/DocGenerator.kt (+28 -6)
📝 pkl-doc/src/main/kotlin/org/pkl/doc/Main.kt (+16 -1)
📝 pkl-doc/src/test/kotlin/org/pkl/doc/CliDocGeneratorTest.kt (+30 -7)
📝 pkl-gradle/src/main/java/org/pkl/gradle/PklPlugin.java (+7 -1)
📝 pkl-gradle/src/main/java/org/pkl/gradle/spec/PkldocSpec.java (+4 -1)
📝 pkl-gradle/src/main/java/org/pkl/gradle/task/PkldocTask.java (+10 -2)

📄 Description

Some systems, for example, GitHub Pages, have trouble with handling symlinks, which breaks the current directory links created by Pkldoc. In this PR, we add an alternative mode which creates a full copy of the latest published version contents in the current directory instead.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/apple/pkl/pull/824 **Author:** [@netvl](https://github.com/netvl) **Created:** 11/19/2024 **Status:** ✅ Merged **Merged:** 2/19/2025 **Merged by:** [@bioball](https://github.com/bioball) **Base:** `main` ← **Head:** `current-publishing-variants` --- ### 📝 Commits (2) - [`c64f5ec`](https://github.com/apple/pkl/commit/c64f5ec6bb1d816ee57fa2e0f3b70e836f46a390) Added an ability to avoid creating symlinks in Pkldoc - [`2e475d9`](https://github.com/apple/pkl/commit/2e475d94349082ed5711bb900dc2eaa75c7e9ffb) Adjust test and documentation ### 📊 Changes **11 files changed** (+143 additions, -19 deletions) <details> <summary>View changed files</summary> 📝 `docs/modules/pkl-doc/pages/index.adoc` (+9 -1) 📝 `docs/modules/pkl-gradle/pages/index.adoc` (+11 -0) 📝 `pkl-commons/src/main/kotlin/org/pkl/commons/Paths.kt` (+16 -0) 📝 `pkl-doc/src/main/kotlin/org/pkl/doc/CliDocGenerator.kt` (+1 -0) 📝 `pkl-doc/src/main/kotlin/org/pkl/doc/CliDocGeneratorOptions.kt` (+11 -0) 📝 `pkl-doc/src/main/kotlin/org/pkl/doc/DocGenerator.kt` (+28 -6) 📝 `pkl-doc/src/main/kotlin/org/pkl/doc/Main.kt` (+16 -1) 📝 `pkl-doc/src/test/kotlin/org/pkl/doc/CliDocGeneratorTest.kt` (+30 -7) 📝 `pkl-gradle/src/main/java/org/pkl/gradle/PklPlugin.java` (+7 -1) 📝 `pkl-gradle/src/main/java/org/pkl/gradle/spec/PkldocSpec.java` (+4 -1) 📝 `pkl-gradle/src/main/java/org/pkl/gradle/task/PkldocTask.java` (+10 -2) </details> ### 📄 Description Some systems, for example, GitHub Pages, have trouble with handling symlinks, which breaks the `current` directory links created by Pkldoc. In this PR, we add an alternative mode which creates a full copy of the latest published version contents in the `current` directory instead. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

adam added the pull-request label 2025-12-30 01:26:34 +01:00

adam closed this issue

2025-12-30 01:26:34 +01:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/pkl#760