starred/pkl
1
0 Fork 0
mirror of https://github.com/apple/pkl.git synced 2026-11-14 04:43:30 +01:00
Code Issues 198 Packages Projects Releases 10 Wiki Activity

[PR #708] [MERGED] Store PklProject annotations in the project metadata #689

New Issue
Closed
opened 2025-12-30 01:26:10 +01:00 by adam · 0 comments
adam commented 2025-12-30 01:26:10 +01:00
Owner
Copy link
Copy source

📋 Pull Request Information

Original PR: https://github.com/apple/pkl/pull/708
Author: @stackoverflow
Created: 10/18/2024
Status: ✅ Merged
Merged: 10/25/2024
Merged by: @bioball

Base: main ← Head: project-annotation-metadata

📝 Commits (8)

  • 66857ac add annotation metadata to project metadata
  • f3c7561 use annotations from project metadata to inform doc generation
  • dba1274 add tests for package doc generation
  • 342ec0e fix test
  • 93e5660 do not write annotations if they are empty
  • b20a098 add support for more types in annotations
  • 52972d3 fixed remarks
  • 4b1b0e6 support maps with non-string keys

📊 Changes

22 files changed (+976 additions, -17 deletions)

View changed files

📝 pkl-cli/src/test/kotlin/org/pkl/cli/CliProjectPackagerTest.kt (+86 -0)
➕ pkl-commons-test/src/main/files/packages/deprecated@1.0.0/deprecated@1.0.0.json (+33 -0)
➕ pkl-commons-test/src/main/files/packages/deprecated@1.0.0/package/deprecated.pkl (+9 -0)
➕ pkl-commons-test/src/main/files/packages/unlisted@1.0.0/package/unlisted.pkl (+5 -0)
➕ pkl-commons-test/src/main/files/packages/unlisted@1.0.0/unlisted@1.0.0.json (+29 -0)
📝 pkl-core/src/main/java/org/pkl/core/packages/DependencyMetadata.java (+284 -5)
📝 pkl-core/src/main/java/org/pkl/core/project/Project.java (+19 -4)
📝 pkl-core/src/main/java/org/pkl/core/project/ProjectPackager.java (+2 -1)
📝 pkl-core/src/test/kotlin/org/pkl/core/packages/DependencyMetadataTest.kt (+182 -4)
📝 pkl-core/src/test/kotlin/org/pkl/core/project/ProjectTest.kt (+13 -0)
📝 pkl-doc/src/main/kotlin/org/pkl/doc/CliDocGenerator.kt (+2 -1)
➕ pkl-doc/src/test/files/DocGeneratorTest/output/data/localhost(3a)0/deprecated/1.0.0/deprecated/index.js (+1 -0)
➕ pkl-doc/src/test/files/DocGeneratorTest/output/data/localhost(3a)0/deprecated/1.0.0/index.js (+1 -0)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/index.html (+12 -0)
➕ pkl-doc/src/test/files/DocGeneratorTest/output/localhost(3a)0/deprecated/1.0.0/deprecated/index.html (+219 -0)
➕ pkl-doc/src/test/files/DocGeneratorTest/output/localhost(3a)0/deprecated/1.0.0/index.html (+68 -0)
➕ pkl-doc/src/test/files/DocGeneratorTest/output/localhost(3a)0/deprecated/1.0.0/package-data.json (+1 -0)
➕ pkl-doc/src/test/files/DocGeneratorTest/output/localhost(3a)0/deprecated/1.0.0/search-index.js (+1 -0)
➕ pkl-doc/src/test/files/DocGeneratorTest/output/localhost(3a)0/deprecated/current (+1 -0)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/search-index.js (+1 -1)

...and 2 more files

📄 Description

Store PklProject annotations in the project metadata and use these annotations to inform doc generation.

🔄 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/708 **Author:** [@stackoverflow](https://github.com/stackoverflow) **Created:** 10/18/2024 **Status:** ✅ Merged **Merged:** 10/25/2024 **Merged by:** [@bioball](https://github.com/bioball) **Base:** `main` ← **Head:** `project-annotation-metadata` --- ### 📝 Commits (8) - [`66857ac`](https://github.com/apple/pkl/commit/66857ac70c1f30ae6cc0596179f8edb79297a125) add annotation metadata to project metadata - [`f3c7561`](https://github.com/apple/pkl/commit/f3c75618e00c33f6cf857fa178c7d45c0497eaf6) use annotations from project metadata to inform doc generation - [`dba1274`](https://github.com/apple/pkl/commit/dba1274a95e79daf2643360c77bf4def1cfa7320) add tests for package doc generation - [`342ec0e`](https://github.com/apple/pkl/commit/342ec0e9e823a18b49a247661e26bf9ff76fd78d) fix test - [`93e5660`](https://github.com/apple/pkl/commit/93e5660b3302d1e80cfc43c768bfcdc84116e50c) do not write annotations if they are empty - [`b20a098`](https://github.com/apple/pkl/commit/b20a0987935ea9eab650a67e22500f2378840d5a) add support for more types in annotations - [`52972d3`](https://github.com/apple/pkl/commit/52972d3ffd10a653b1e66fa35dcd3b69e58bdfe5) fixed remarks - [`4b1b0e6`](https://github.com/apple/pkl/commit/4b1b0e648759e2151fa9f156bd5f6ec8e97884dd) support maps with non-string keys ### 📊 Changes **22 files changed** (+976 additions, -17 deletions) <details> <summary>View changed files</summary> 📝 `pkl-cli/src/test/kotlin/org/pkl/cli/CliProjectPackagerTest.kt` (+86 -0) ➕ `pkl-commons-test/src/main/files/packages/deprecated@1.0.0/deprecated@1.0.0.json` (+33 -0) ➕ `pkl-commons-test/src/main/files/packages/deprecated@1.0.0/package/deprecated.pkl` (+9 -0) ➕ `pkl-commons-test/src/main/files/packages/unlisted@1.0.0/package/unlisted.pkl` (+5 -0) ➕ `pkl-commons-test/src/main/files/packages/unlisted@1.0.0/unlisted@1.0.0.json` (+29 -0) 📝 `pkl-core/src/main/java/org/pkl/core/packages/DependencyMetadata.java` (+284 -5) 📝 `pkl-core/src/main/java/org/pkl/core/project/Project.java` (+19 -4) 📝 `pkl-core/src/main/java/org/pkl/core/project/ProjectPackager.java` (+2 -1) 📝 `pkl-core/src/test/kotlin/org/pkl/core/packages/DependencyMetadataTest.kt` (+182 -4) 📝 `pkl-core/src/test/kotlin/org/pkl/core/project/ProjectTest.kt` (+13 -0) 📝 `pkl-doc/src/main/kotlin/org/pkl/doc/CliDocGenerator.kt` (+2 -1) ➕ `pkl-doc/src/test/files/DocGeneratorTest/output/data/localhost(3a)0/deprecated/1.0.0/deprecated/index.js` (+1 -0) ➕ `pkl-doc/src/test/files/DocGeneratorTest/output/data/localhost(3a)0/deprecated/1.0.0/index.js` (+1 -0) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/index.html` (+12 -0) ➕ `pkl-doc/src/test/files/DocGeneratorTest/output/localhost(3a)0/deprecated/1.0.0/deprecated/index.html` (+219 -0) ➕ `pkl-doc/src/test/files/DocGeneratorTest/output/localhost(3a)0/deprecated/1.0.0/index.html` (+68 -0) ➕ `pkl-doc/src/test/files/DocGeneratorTest/output/localhost(3a)0/deprecated/1.0.0/package-data.json` (+1 -0) ➕ `pkl-doc/src/test/files/DocGeneratorTest/output/localhost(3a)0/deprecated/1.0.0/search-index.js` (+1 -0) ➕ `pkl-doc/src/test/files/DocGeneratorTest/output/localhost(3a)0/deprecated/current` (+1 -0) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/search-index.js` (+1 -1) _...and 2 more files_ </details> ### 📄 Description Store `PklProject` annotations in the project metadata and use these annotations to inform doc generation. --- <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:10 +01:00
adam closed this issue 2025-12-30 01:26:10 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Labels
Clear labels
bug
duplicate
enhancement
good first issue
help wanted
pull-request
Mirrored from GitHub Pull Request
No labels pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
adam (Adam Melkus)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/pkl#689