├── .circleci ├── config.pkl └── config.yml ├── .gitignore ├── .idea ├── .gitignore ├── codeStyles │ ├── Project.xml │ └── codeStyleConfig.xml ├── gradle.xml ├── inspectionProfiles │ └── Project_Default.xml ├── kotlinc.xml ├── misc.xml ├── sbt.xml └── vcs.xml ├── CODE_OF_CONDUCT.adoc ├── CONTRIBUTING.adoc ├── LICENSE.txt ├── MAINTAINERS.adoc ├── NOTICE.txt ├── README.adoc ├── SECURITY.adoc ├── build.gradle.kts ├── gradle.properties ├── gradle ├── libs.versions.toml └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── settings.gradle.kts └── src └── main ├── kotlin └── org │ └── pkl │ └── package_docs │ ├── GitHubClient.kt │ ├── Main.kt │ └── PackageDocs.kt └── resources └── org └── pkl └── package_docs └── docsite-info.pkl /.circleci/config.pkl: -------------------------------------------------------------------------------- 1 | //===----------------------------------------------------------------------===// 2 | // Copyright © 2024-2025 Apple Inc. and the Pkl project authors. All rights reserved. 3 | // 4 | // Licensed under the Apache License, Version 2.0 (the "License"); 5 | // you may not use this file except in compliance with the License. 6 | // You may obtain a copy of the License at 7 | // 8 | // https://www.apache.org/licenses/LICENSE-2.0 9 | // 10 | // Unless required by applicable law or agreed to in writing, software 11 | // distributed under the License is distributed on an "AS IS" BASIS, 12 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | // See the License for the specific language governing permissions and 14 | // limitations under the License. 15 | //===----------------------------------------------------------------------===// 16 | amends "package://pkg.pkl-lang.org/pkl-project-commons/pkl.impl.circleci@1.0.2#/PklCI.pkl" 17 | 18 | prb { 19 | jobs { 20 | "test" 21 | } 22 | } 23 | 24 | main { 25 | jobs { 26 | new { 27 | ["publish-docs"] { 28 | context { 29 | "pkl-github-release" 30 | } 31 | } 32 | } 33 | } 34 | } 35 | 36 | jobs { 37 | ["test"] { 38 | docker { 39 | new { image = "cimg/openjdk:17.0" } 40 | } 41 | steps { 42 | "checkout" 43 | new RunStep { 44 | command = "./gradlew check" 45 | } 46 | } 47 | } 48 | ["publish-docs"] { 49 | docker { 50 | new { image = "cimg/openjdk:17.0" } 51 | } 52 | steps { 53 | "checkout" 54 | new RunStep { 55 | command = "./gradlew generateAndPublishDocs --refresh-dependencies" 56 | } 57 | } 58 | } 59 | } 60 | 61 | triggerDocsBuild = "both" 62 | -------------------------------------------------------------------------------- /.circleci/config.yml: -------------------------------------------------------------------------------- 1 | # Generated from CircleCI.pkl. DO NOT EDIT. 2 | version: '2.1' 3 | orbs: 4 | pr-approval: apple/pr-approval@0.1.0 5 | jobs: 6 | test: 7 | steps: 8 | - checkout 9 | - run: 10 | command: ./gradlew check 11 | docker: 12 | - image: cimg/openjdk:17.0 13 | publish-docs: 14 | steps: 15 | - checkout 16 | - run: 17 | command: ./gradlew generateAndPublishDocs --refresh-dependencies 18 | docker: 19 | - image: cimg/openjdk:17.0 20 | trigger-docsite-build: 21 | steps: 22 | - run: 23 | command: |- 24 | curl --location \ 25 | --request POST \ 26 | --header "Content-Type: application/json" \ 27 | -u "${CIRCLE_TOKEN}:" \ 28 | --data '{ "branch": "main" }' \ 29 | "https://circleci.com/api/v2/project/github/apple/pkl-lang.org/pipeline" 30 | name: Triggering docsite build 31 | docker: 32 | - image: cimg/base:current 33 | workflows: 34 | prb: 35 | jobs: 36 | - hold: 37 | type: approval 38 | - pr-approval/authenticate: 39 | context: pkl-pr-approval 40 | - test: 41 | requires: 42 | - hold 43 | when: 44 | matches: 45 | value: << pipeline.git.branch >> 46 | pattern: ^pull/\d+(/head)?$ 47 | main: 48 | jobs: 49 | - publish-docs: 50 | context: 51 | - pkl-github-release 52 | - trigger-docsite-build: 53 | requires: 54 | - publish-docs 55 | context: 56 | - pkl-pr-approval 57 | when: 58 | equal: 59 | - main 60 | - << pipeline.git.branch >> 61 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .gradle 2 | build/ 3 | **/src/main/**/build/ 4 | **/src/test/**/build/ 5 | 6 | # IDEA 7 | .idea/modules.xml 8 | .idea/jarRepositories.xml 9 | .idea/compiler.xml 10 | .idea/libraries/ 11 | *.iws 12 | *.iml 13 | *.ipr 14 | out/ 15 | **/src/main/**/out/ 16 | **/src/test/**/out/ 17 | 18 | # macOS 19 | .DS_Store 20 | -------------------------------------------------------------------------------- /.idea/.gitignore: -------------------------------------------------------------------------------- 1 | # Default ignored files 2 | /shelf/ 3 | /workspace.xml 4 | # Editor-based HTTP Client requests 5 | /httpRequests/ 6 | # Datasource local storage ignored files 7 | /dataSources/ 8 | /dataSources.local.xml 9 | -------------------------------------------------------------------------------- /.idea/codeStyles/Project.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 6 | 7 | -------------------------------------------------------------------------------- /.idea/codeStyles/codeStyleConfig.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | -------------------------------------------------------------------------------- /.idea/gradle.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 15 | 16 | -------------------------------------------------------------------------------- /.idea/inspectionProfiles/Project_Default.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 11 | -------------------------------------------------------------------------------- /.idea/kotlinc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 6 | -------------------------------------------------------------------------------- /.idea/misc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /.idea/sbt.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 6 | -------------------------------------------------------------------------------- /.idea/vcs.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.adoc: -------------------------------------------------------------------------------- 1 | == Code of Conduct 2 | 3 | === Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our 7 | project and our community a harassment-free experience for everyone, 8 | regardless of age, body size, disability, ethnicity, sex 9 | characteristics, gender identity and expression, level of experience, 10 | education, socio-economic status, nationality, personal appearance, 11 | race, religion, or sexual identity and orientation. 12 | 13 | === Our Standards 14 | 15 | Examples of behavior that contributes to creating a positive environment 16 | include: 17 | 18 | * Using welcoming and inclusive language 19 | * Being respectful of differing viewpoints and experiences 20 | * Gracefully accepting constructive criticism 21 | * Focusing on what is best for the community 22 | * Showing empathy towards other community members 23 | 24 | Examples of unacceptable behavior by participants include: 25 | 26 | * The use of sexualized language or imagery and unwelcome sexual 27 | attention or advances 28 | * Trolling, insulting/derogatory comments, and personal or political 29 | attacks 30 | * Public or private harassment 31 | * Publishing others’ private information, such as a physical or 32 | electronic address, without explicit permission 33 | * Other conduct which could reasonably be considered inappropriate in a 34 | professional setting 35 | 36 | === Our Responsibilities 37 | 38 | Project maintainers are responsible for clarifying the standards of 39 | acceptable behavior and are expected to take appropriate and fair 40 | corrective action in response to any instances of unacceptable behavior. 41 | 42 | Project maintainers have the right and responsibility to remove, edit, 43 | or reject comments, commits, code, wiki edits, issues, and other 44 | contributions that are not aligned to this Code of Conduct, or to ban 45 | temporarily or permanently any contributor for other behaviors that they 46 | deem inappropriate, threatening, offensive, or harmful. 47 | 48 | === Scope 49 | 50 | This Code of Conduct applies within all project spaces, and it also 51 | applies when an individual is representing the project or its community 52 | in public spaces. Examples of representing a project or community 53 | include using an official project e-mail address, posting via an 54 | official social media account, or acting as an appointed representative 55 | at an online or offline event. Representation of a project may be 56 | further defined and clarified by project maintainers. 57 | 58 | === Enforcement 59 | 60 | Instances of abusive, harassing, or otherwise unacceptable behavior may 61 | be reported by contacting the open source team at 62 | opensource-conduct@group.apple.com. All complaints will be reviewed and 63 | investigated and will result in a response that is deemed necessary and 64 | appropriate to the circumstances. The project team is obligated to 65 | maintain confidentiality with regard to the reporter of an incident. 66 | Further details of specific enforcement policies may be posted 67 | separately. 68 | 69 | Project maintainers who do not follow or enforce the Code of Conduct in 70 | good faith may face temporary or permanent repercussions as determined 71 | by other members of the project’s leadership. 72 | 73 | === Attribution 74 | 75 | This Code of Conduct is adapted from the 76 | https://www.contributor-covenant.org[Contributor Covenant], version 1.4, 77 | available at 78 | https://www.contributor-covenant.org/version/1/4/code-of-conduct.html 79 | -------------------------------------------------------------------------------- /CONTRIBUTING.adoc: -------------------------------------------------------------------------------- 1 | :uri-github-issue-pkl-package-docs: https://github.com/apple/pkl-package-docs/issues/new 2 | :uri-seven-rules: https://cbea.ms/git-commit/#seven-rules 3 | 4 | = Pkl Package Docs Contributors Guide 5 | 6 | Welcome to the Pkl community, and thank you for contributing! 7 | This guide explains how to get involved. 8 | 9 | * <> 10 | * <> 11 | * <> 12 | 13 | == Licensing 14 | 15 | Pkl Package Docs is released under the Apache 2.0 license. 16 | This is why we require that, by submitting a pull request, you acknowledge that you have the right to license your contribution to Apple and the community, and agree that your contribution is licensed under the Apache 2.0 license. 17 | 18 | == Issue Tracking 19 | 20 | To file a bug or feature request, use {uri-github-issue-pkl-package-docs}[GitHub]. 21 | Be sure to include the following information: 22 | 23 | * Context 24 | ** What are/were you trying to achieve? 25 | ** What's the impact of this bug/feature? 26 | 27 | == Pull Requests 28 | 29 | When preparing a pull request, follow this checklist: 30 | 31 | * Imitate the conventions of surrounding code. 32 | * Follow the {uri-seven-rules}[seven rules] of great Git commit messages: 33 | ** Separate subject from body with a blank line. 34 | ** Limit the subject line to 50 characters. 35 | ** Capitalize the subject line. 36 | ** Do not end the subject line with a period. 37 | ** Use the imperative mood in the subject line. 38 | ** Wrap the body at 72 characters. 39 | ** Use the body to explain what and why vs. how. 40 | 41 | == Maintainers 42 | 43 | The project’s maintainers (those with write access to the upstream repository) are listed in link:MAINTAINERS.adoc[]. 44 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | 204 | 205 | ## Runtime Library Exception to the Apache 2.0 License: ## 206 | 207 | 208 | As an exception, if you use this Software to compile your source code and 209 | portions of this Software are embedded into the binary product as a result, 210 | you may redistribute such product without providing attribution as would 211 | otherwise be required by Sections 4(a), 4(b) and 4(d) of the License. 212 | -------------------------------------------------------------------------------- /MAINTAINERS.adoc: -------------------------------------------------------------------------------- 1 | = MAINTAINERS 2 | 3 | This page lists all active Maintainers of this repository. 4 | 5 | See link:CONTRIBUTING.adoc[] for general contribution guidelines. 6 | 7 | == Maintainers (in alphabetical order) 8 | 9 | * https://github.com/bioball[Daniel Chao] 10 | * https://github.com/stackoverflow[Islon Scherer] 11 | * https://github.com/holzensp[Philip Hölzenspies] 12 | -------------------------------------------------------------------------------- /NOTICE.txt: -------------------------------------------------------------------------------- 1 | Copyright © 2024-2025 Apple Inc. and the Pkl project authors 2 | 3 | Portions of this software includes code from "Gradle" by Gradle, Inc. 4 | 5 | Copyright 2015 the original author or authors. 6 | 7 | Licensed under the Apache License, Version 2.0 (the "License"); 8 | you may not use this file except in compliance with the License. 9 | You may obtain a copy of the License at 10 | 11 | https://www.apache.org/licenses/LICENSE-2.0 12 | 13 | Unless required by applicable law or agreed to in writing, software 14 | distributed under the License is distributed on an "AS IS" BASIS, 15 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 | See the License for the specific language governing permissions and 17 | limitations under the License. 18 | -------------------------------------------------------------------------------- /README.adoc: -------------------------------------------------------------------------------- 1 | = Package Docs 2 | 3 | This repository hosts pkldoc documentation for Pkl packages. 4 | 5 | It scans for new packages by polling for the latest GitHub releases from a set of GitHub repositories. 6 | 7 | == How documentation is generated 8 | 9 | This repository scans for new releases of packages from a set of repositories, determined in link:build.gradle.kts[]. 10 | 11 | It works by listing releases of each of these repositories, and spawnings the pkldoc generator with the latest set of each package. 12 | 13 | The documentation gets pushed to the `www` branch of this repository. 14 | Once the documentation is pushed, the CI build for pkl-lang.org is triggered, which clones down the `www` branch and adds its contents to the resulting website. 15 | -------------------------------------------------------------------------------- /SECURITY.adoc: -------------------------------------------------------------------------------- 1 | = Security 2 | 3 | For the protection of our community, the Pkl team does not disclose, discuss, or confirm security issues until our investigation is complete and any necessary updates are generally available. 4 | 5 | == Reporting a security vulnerability 6 | 7 | If you have discovered a security vulnerability within the Pkl Package Docs project, please report it to us. 8 | We welcome reports from everyone, including security researchers, developers, and users. 9 | 10 | Security vulnerabilities may be reported on the link:https://security.apple.com/submit[Report a vulnerability] form. 11 | When submitting a vulnerability, select "Apple Devices and Software" as the affected platform, and "Open Source" as the affected area. 12 | 13 | For more information, see https://pkl-lang.org/security.html. 14 | -------------------------------------------------------------------------------- /build.gradle.kts: -------------------------------------------------------------------------------- 1 | plugins { 2 | kotlin("jvm") version libs.versions.kotlin 3 | alias(libs.plugins.pkl) 4 | alias(libs.plugins.spotless) 5 | alias(libs.plugins.kotlinSerialization) 6 | } 7 | 8 | group = "org.pkl-lang" 9 | version = "1.0-SNAPSHOT" 10 | 11 | repositories { 12 | mavenCentral() 13 | } 14 | 15 | dependencies { 16 | implementation(libs.pklDoc) 17 | implementation(libs.pklCommonsCli) 18 | implementation(libs.ktorClientCore) 19 | implementation(libs.ktorClientJava) 20 | implementation(libs.kotlinxSerializationJson) 21 | testImplementation(kotlin("test")) 22 | } 23 | 24 | tasks.test { 25 | useJUnitPlatform() 26 | } 27 | 28 | kotlin { 29 | jvmToolchain(17) 30 | } 31 | 32 | val repos = arrayOf( 33 | "apple/pkl-pantry", 34 | "apple/pkl-k8s", 35 | "apple/pkl-go", 36 | "apple/pkl-swift" 37 | ) 38 | 39 | tasks.create("generateAndPublishDocs") { 40 | group = "publish" 41 | configureBuild(doPublish = true) 42 | } 43 | 44 | val generateDocs by tasks.registering(JavaExec::class) { 45 | group = "build" 46 | configureBuild(doPublish = false) 47 | } 48 | 49 | fun JavaExec.configureBuild(doPublish: Boolean) { 50 | val outputDir = file("build/package-docs") 51 | val gitRootDir = file(".") 52 | mainClass.set("org.pkl.package_docs.MainKt") 53 | classpath = sourceSets.main.get().runtimeClasspath 54 | args = buildList { 55 | add(gitRootDir.absolutePath) 56 | add(outputDir.absolutePath) 57 | add(if (doPublish) "1" else "0") 58 | addAll(repos) 59 | } 60 | } 61 | 62 | val originalRemoteName = System.getenv("PKL_ORIGINAL_REMOTE_NAME") ?: "origin" 63 | 64 | spotless { 65 | ratchetFrom = "$originalRemoteName/main" 66 | kotlin { 67 | licenseHeader(""" 68 | /** 69 | * Copyright © ${'$'}YEAR Apple Inc. and the Pkl project authors. All rights reserved. 70 | * 71 | * Licensed under the Apache License, Version 2.0 (the "License"); 72 | * you may not use this file except in compliance with the License. 73 | * You may obtain a copy of the License at 74 | * 75 | * https://www.apache.org/licenses/LICENSE-2.0 76 | * 77 | * Unless required by applicable law or agreed to in writing, software 78 | * distributed under the License is distributed on an "AS IS" BASIS, 79 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 80 | * See the License for the specific language governing permissions and 81 | * limitations under the License. 82 | */ 83 | """.trimIndent()) 84 | } 85 | format("pkl") { 86 | licenseHeader(""" 87 | //===----------------------------------------------------------------------===// 88 | // Copyright © ${'$'}YEAR Apple Inc. and the Pkl project authors. All rights reserved. 89 | // 90 | // Licensed under the Apache License, Version 2.0 (the "License"); 91 | // you may not use this file except in compliance with the License. 92 | // You may obtain a copy of the License at 93 | // 94 | // https://www.apache.org/licenses/LICENSE-2.0 95 | // 96 | // Unless required by applicable law or agreed to in writing, software 97 | // distributed under the License is distributed on an "AS IS" BASIS, 98 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 99 | // See the License for the specific language governing permissions and 100 | // limitations under the License. 101 | //===----------------------------------------------------------------------===// 102 | """.trimIndent(), "(/// |/\\*\\*|module |import |amends |(\\w+))") 103 | target("**/*.pkl", "**/PklProject") 104 | } 105 | } 106 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | kotlin.code.style=official 2 | -------------------------------------------------------------------------------- /gradle/libs.versions.toml: -------------------------------------------------------------------------------- 1 | [versions] 2 | pkl = "0.+" 3 | ktor = "2.+" 4 | spotless = "6.25.0" 5 | kotlinxSerialization = "1.6.+" 6 | kotlin = "2.+" 7 | 8 | [libraries] 9 | pklDoc = { group = "org.pkl-lang", name = "pkl-doc", version.ref = "pkl" } 10 | pklCommonsCli = { group = "org.pkl-lang", name = "pkl-commons-cli", version.ref = "pkl" } 11 | pklStdLib = { group = "org.pkl-lang", name = "pkl-stdlib", version.ref = "pkl" } 12 | ktorClientCore = { group = "io.ktor", name = "ktor-client-core", version.ref = "ktor" } 13 | ktorClientJava = { group = "io.ktor", name = "ktor-client-java", version.ref = "ktor" } 14 | kotlinxSerializationJson = { group = "org.jetbrains.kotlinx", name = "kotlinx-serialization-json", version.ref = "kotlinxSerialization" } 15 | 16 | [plugins] 17 | pkl = { id = "org.pkl-lang", version.ref = "pkl" } 18 | spotless = { id = "com.diffplug.spotless", version.ref = "spotless" } 19 | kotlinSerialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" } 20 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apple/pkl-package-docs/e0e16bcb10ee5d1072998256e9b860fb66254037/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip 4 | networkTimeout=10000 5 | validateDistributionUrl=true 6 | zipStoreBase=GRADLE_USER_HOME 7 | zipStorePath=wrapper/dists 8 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | # 21 | # Gradle start up script for POSIX generated by Gradle. 22 | # 23 | # Important for running: 24 | # 25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 26 | # noncompliant, but you have some other compliant shell such as ksh or 27 | # bash, then to run this script, type that shell name before the whole 28 | # command line, like: 29 | # 30 | # ksh Gradle 31 | # 32 | # Busybox and similar reduced shells will NOT work, because this script 33 | # requires all of these POSIX shell features: 34 | # * functions; 35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 37 | # * compound commands having a testable exit status, especially «case»; 38 | # * various built-in commands including «command», «set», and «ulimit». 39 | # 40 | # Important for patching: 41 | # 42 | # (2) This script targets any POSIX shell, so it avoids extensions provided 43 | # by Bash, Ksh, etc; in particular arrays are avoided. 44 | # 45 | # The "traditional" practice of packing multiple parameters into a 46 | # space-separated string is a well documented source of bugs and security 47 | # problems, so this is (mostly) avoided, by progressively accumulating 48 | # options in "$@", and eventually passing that to Java. 49 | # 50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 52 | # see the in-line comments for details. 53 | # 54 | # There are tweaks for specific operating systems such as AIX, CygWin, 55 | # Darwin, MinGW, and NonStop. 56 | # 57 | # (3) This script is generated from the Groovy template 58 | # https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 59 | # within the Gradle project. 60 | # 61 | # You can find Gradle at https://github.com/gradle/gradle/. 62 | # 63 | ############################################################################## 64 | 65 | # Attempt to set APP_HOME 66 | 67 | # Resolve links: $0 may be a link 68 | app_path=$0 69 | 70 | # Need this for daisy-chained symlinks. 71 | while 72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 73 | [ -h "$app_path" ] 74 | do 75 | ls=$( ls -ld "$app_path" ) 76 | link=${ls#*' -> '} 77 | case $link in #( 78 | /*) app_path=$link ;; #( 79 | *) app_path=$APP_HOME$link ;; 80 | esac 81 | done 82 | 83 | # This is normally unused 84 | # shellcheck disable=SC2034 85 | APP_BASE_NAME=${0##*/} 86 | # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) 87 | APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit 88 | 89 | # Use the maximum available, or set MAX_FD != -1 to use that value. 90 | MAX_FD=maximum 91 | 92 | warn () { 93 | echo "$*" 94 | } >&2 95 | 96 | die () { 97 | echo 98 | echo "$*" 99 | echo 100 | exit 1 101 | } >&2 102 | 103 | # OS specific support (must be 'true' or 'false'). 104 | cygwin=false 105 | msys=false 106 | darwin=false 107 | nonstop=false 108 | case "$( uname )" in #( 109 | CYGWIN* ) cygwin=true ;; #( 110 | Darwin* ) darwin=true ;; #( 111 | MSYS* | MINGW* ) msys=true ;; #( 112 | NONSTOP* ) nonstop=true ;; 113 | esac 114 | 115 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 116 | 117 | 118 | # Determine the Java command to use to start the JVM. 119 | if [ -n "$JAVA_HOME" ] ; then 120 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 121 | # IBM's JDK on AIX uses strange locations for the executables 122 | JAVACMD=$JAVA_HOME/jre/sh/java 123 | else 124 | JAVACMD=$JAVA_HOME/bin/java 125 | fi 126 | if [ ! -x "$JAVACMD" ] ; then 127 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 128 | 129 | Please set the JAVA_HOME variable in your environment to match the 130 | location of your Java installation." 131 | fi 132 | else 133 | JAVACMD=java 134 | if ! command -v java >/dev/null 2>&1 135 | then 136 | die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 137 | 138 | Please set the JAVA_HOME variable in your environment to match the 139 | location of your Java installation." 140 | fi 141 | fi 142 | 143 | # Increase the maximum file descriptors if we can. 144 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 145 | case $MAX_FD in #( 146 | max*) 147 | # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. 148 | # shellcheck disable=SC2039,SC3045 149 | MAX_FD=$( ulimit -H -n ) || 150 | warn "Could not query maximum file descriptor limit" 151 | esac 152 | case $MAX_FD in #( 153 | '' | soft) :;; #( 154 | *) 155 | # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. 156 | # shellcheck disable=SC2039,SC3045 157 | ulimit -n "$MAX_FD" || 158 | warn "Could not set maximum file descriptor limit to $MAX_FD" 159 | esac 160 | fi 161 | 162 | # Collect all arguments for the java command, stacking in reverse order: 163 | # * args from the command line 164 | # * the main class name 165 | # * -classpath 166 | # * -D...appname settings 167 | # * --module-path (only if needed) 168 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 169 | 170 | # For Cygwin or MSYS, switch paths to Windows format before running java 171 | if "$cygwin" || "$msys" ; then 172 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 173 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 174 | 175 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 176 | 177 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 178 | for arg do 179 | if 180 | case $arg in #( 181 | -*) false ;; # don't mess with options #( 182 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 183 | [ -e "$t" ] ;; #( 184 | *) false ;; 185 | esac 186 | then 187 | arg=$( cygpath --path --ignore --mixed "$arg" ) 188 | fi 189 | # Roll the args list around exactly as many times as the number of 190 | # args, so each arg winds up back in the position where it started, but 191 | # possibly modified. 192 | # 193 | # NB: a `for` loop captures its iteration list before it begins, so 194 | # changing the positional parameters here affects neither the number of 195 | # iterations, nor the values presented in `arg`. 196 | shift # remove old arg 197 | set -- "$@" "$arg" # push replacement arg 198 | done 199 | fi 200 | 201 | 202 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 203 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 204 | 205 | # Collect all arguments for the java command: 206 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, 207 | # and any embedded shellness will be escaped. 208 | # * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be 209 | # treated as '${Hostname}' itself on the command line. 210 | 211 | set -- \ 212 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 213 | -classpath "$CLASSPATH" \ 214 | org.gradle.wrapper.GradleWrapperMain \ 215 | "$@" 216 | 217 | # Stop when "xargs" is not available. 218 | if ! command -v xargs >/dev/null 2>&1 219 | then 220 | die "xargs is not available" 221 | fi 222 | 223 | # Use "xargs" to parse quoted args. 224 | # 225 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 226 | # 227 | # In Bash we could simply go: 228 | # 229 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 230 | # set -- "${ARGS[@]}" "$@" 231 | # 232 | # but POSIX shell has neither arrays nor command substitution, so instead we 233 | # post-process each arg (as a line of input to sed) to backslash-escape any 234 | # character that might be a shell metacharacter, then use eval to reverse 235 | # that process (while maintaining the separation between arguments), and wrap 236 | # the whole thing up as a single "set" statement. 237 | # 238 | # This will of course break if any of these variables contains a newline or 239 | # an unmatched quote. 240 | # 241 | 242 | eval "set -- $( 243 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 244 | xargs -n1 | 245 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 246 | tr '\n' ' ' 247 | )" '"$@"' 248 | 249 | exec "$JAVACMD" "$@" 250 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%"=="" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%"=="" set DIRNAME=. 29 | @rem This is normally unused 30 | set APP_BASE_NAME=%~n0 31 | set APP_HOME=%DIRNAME% 32 | 33 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 34 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 35 | 36 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 37 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 38 | 39 | @rem Find java.exe 40 | if defined JAVA_HOME goto findJavaFromJavaHome 41 | 42 | set JAVA_EXE=java.exe 43 | %JAVA_EXE% -version >NUL 2>&1 44 | if %ERRORLEVEL% equ 0 goto execute 45 | 46 | echo. 47 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 48 | echo. 49 | echo Please set the JAVA_HOME variable in your environment to match the 50 | echo location of your Java installation. 51 | 52 | goto fail 53 | 54 | :findJavaFromJavaHome 55 | set JAVA_HOME=%JAVA_HOME:"=% 56 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 57 | 58 | if exist "%JAVA_EXE%" goto execute 59 | 60 | echo. 61 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 62 | echo. 63 | echo Please set the JAVA_HOME variable in your environment to match the 64 | echo location of your Java installation. 65 | 66 | goto fail 67 | 68 | :execute 69 | @rem Setup the command line 70 | 71 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 72 | 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if %ERRORLEVEL% equ 0 goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | set EXIT_CODE=%ERRORLEVEL% 85 | if %EXIT_CODE% equ 0 set EXIT_CODE=1 86 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% 87 | exit /b %EXIT_CODE% 88 | 89 | :mainEnd 90 | if "%OS%"=="Windows_NT" endlocal 91 | 92 | :omega 93 | -------------------------------------------------------------------------------- /settings.gradle.kts: -------------------------------------------------------------------------------- 1 | pluginManagement { 2 | repositories { 3 | maven(url = "https://s01.oss.sonatype.org/content/groups/public/") 4 | mavenCentral() 5 | gradlePluginPortal() 6 | } 7 | } 8 | 9 | plugins { 10 | id("org.gradle.toolchains.foojay-resolver-convention") version "0.5.0" 11 | } 12 | 13 | rootProject.name = "pkl-package-docs" 14 | -------------------------------------------------------------------------------- /src/main/kotlin/org/pkl/package_docs/GitHubClient.kt: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright © 2024 Apple Inc. and the Pkl project authors. All rights reserved. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.pkl.package_docs 17 | 18 | import kotlinx.serialization.ExperimentalSerializationApi 19 | import kotlinx.serialization.Serializable 20 | import kotlinx.serialization.json.Json 21 | import java.net.URI 22 | import java.net.http.HttpClient 23 | import java.net.http.HttpRequest 24 | import java.net.http.HttpResponse 25 | import java.time.Duration 26 | 27 | @Serializable 28 | data class Release(val name: String) 29 | 30 | data class Repo(val owner: String, val name: String) 31 | 32 | class GitHubClient(private val token: String) { 33 | private val baseUri = URI("https://api.github.com") 34 | 35 | @OptIn(ExperimentalSerializationApi::class) 36 | private val json = Json { 37 | ignoreUnknownKeys = true 38 | explicitNulls = false 39 | } 40 | 41 | @Suppress("UastIncorrectHttpHeaderInspection") 42 | private fun httpRequestBuilder(): HttpRequest.Builder { 43 | return HttpRequest.newBuilder().apply { 44 | header("Accept", "application/vnd.github+json") 45 | header("Authorization", "Bearer $token") 46 | header("X-GitHub-Api-Version", "2022-11-28") 47 | } 48 | } 49 | 50 | private val httpClient: HttpClient by lazy { 51 | HttpClient.newBuilder() 52 | .apply { 53 | connectTimeout(Duration.ofSeconds(60)) 54 | } 55 | .build() 56 | } 57 | 58 | private inline fun get(url: String): T { 59 | val request = httpRequestBuilder() 60 | .apply { 61 | GET() 62 | uri(baseUri.resolve(url)) 63 | } 64 | .build() 65 | val respText = httpClient.send(request, HttpResponse.BodyHandlers.ofString()) 66 | return json.decodeFromString(respText.body()) 67 | } 68 | 69 | fun getReleases(repo: Repo): List =get("/repos/${repo.owner}/${repo.name}/releases") 70 | } 71 | -------------------------------------------------------------------------------- /src/main/kotlin/org/pkl/package_docs/Main.kt: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright © 2024 Apple Inc. and the Pkl project authors. All rights reserved. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.pkl.package_docs 17 | 18 | import java.nio.file.Path 19 | 20 | fun main(args: Array) { 21 | val gitRootDir = Path.of(args[0]) 22 | val outputDir = Path.of(args[1]) 23 | val doPublish = args[2] == "1" 24 | val repos = args.drop(3).map { repoStr -> 25 | val (owner, repo) = repoStr.split("/") 26 | Repo(owner, repo) 27 | } 28 | val docsGenerator = PackageDocs(gitRootDir, outputDir, repos) 29 | docsGenerator.generateDocs() 30 | if (doPublish) { 31 | docsGenerator.uploadDocs() 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /src/main/kotlin/org/pkl/package_docs/PackageDocs.kt: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright © 2024-2025 Apple Inc. and the Pkl project authors. All rights reserved. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.pkl.package_docs 17 | 18 | import org.pkl.commons.cli.CliException 19 | import org.pkl.core.Evaluator 20 | import org.pkl.core.ModuleSchema 21 | import org.pkl.core.ModuleSource 22 | import org.pkl.core.PklInfo 23 | import org.pkl.core.Release 24 | import org.pkl.core.SecurityManagers 25 | import org.pkl.core.Version 26 | import org.pkl.core.http.HttpClient 27 | import org.pkl.core.packages.DependencyMetadata 28 | import org.pkl.core.packages.PackageAssetUri 29 | import org.pkl.core.packages.PackageLoadError 30 | import org.pkl.core.packages.PackageResolver 31 | import org.pkl.core.packages.PackageUri 32 | import org.pkl.core.util.IoUtils 33 | import org.pkl.doc.DocGenerator 34 | import org.pkl.doc.DocPackageInfo 35 | import org.pkl.doc.DocsiteInfo 36 | import java.net.URI 37 | import java.nio.file.Path 38 | import java.util.concurrent.TimeUnit 39 | 40 | class PackageDocException(message: String) : Exception(message) 41 | 42 | class PackageDocs( 43 | private val gitRootDir: Path, 44 | private val docsOutputDir: Path, 45 | private val repos: List 46 | ) { 47 | 48 | private val ghToken = System.getenv("GH_TOKEN") ?: throw Error("You must set the GH_TOKEN env var") 49 | private val pklOriginalRemoteName = System.getenv("PKL_ORIGINAL_REMOTE_NAME") ?: "origin" 50 | 51 | private val github = GitHubClient(ghToken) 52 | 53 | private fun discoverPackages(): List { 54 | val allPackages = buildList { 55 | for (repo in repos) { 56 | val releases = github.getReleases(repo) 57 | .filter { it.name.contains('@') } 58 | for (release in releases) { 59 | if (repo.owner == "apple") { 60 | add(PackageUri("package://pkg.pkl-lang.org/${repo.name}/${release.name}")) 61 | } else { 62 | add(PackageUri("package://pkg.pkl-lang.org/github.com/${repo.owner}/${repo.name}/${release.name}")) 63 | } 64 | } 65 | } 66 | } 67 | // get the latest release of every package 68 | return allPackages 69 | .groupBy { it.pathWithoutVersion } 70 | .values 71 | .map { it.sortedBy(PackageUri::getVersion).last() } 72 | } 73 | 74 | fun generateDocs() { 75 | val packages = discoverPackages() 76 | val packageSchemas = packages.mapNotNull(::getSchemasFromPackage).toMap() 77 | // TODO: handle errors and change import resolver signature to `(URI) -> ModuleSchema?` in Pkldoc API 78 | val importResolver: (URI) -> ModuleSchema = 79 | { uri: URI -> evaluator.evaluateSchema(ModuleSource.uri(uri)) } 80 | downloadExistingDocs() 81 | DocGenerator( 82 | docsiteInfo, 83 | mapOf(getStdlibSchemas()) + packageSchemas, 84 | importResolver, 85 | { v1, v2 -> Version.parse(v1).compareTo(Version.parse(v2)) }, 86 | docsOutputDir 87 | ).run() 88 | println("Wrote docs to $docsOutputDir") 89 | print(packages.joinToString("\n")) 90 | } 91 | 92 | fun uploadDocs() { 93 | runCommand(listOf("git", "add", "--all", "."), docsOutputDir) 94 | val diff = runCommandAllowingError(listOf("git", "diff-index", "--quiet", "HEAD"), docsOutputDir) 95 | if (diff.exitValue == 0) { 96 | println("No new docs to upload") 97 | return 98 | } 99 | 100 | runCommand( 101 | listOf( 102 | "git", 103 | "-c", "user.name=Pkl CI", 104 | "-c", "user.email=pkl-oss@group.apple.com", 105 | "commit", 106 | "-m", "Publish new documentation [skip ci]" 107 | ), 108 | docsOutputDir 109 | ) 110 | runCommand(listOf("git", "push", pklOriginalRemoteName, "www"), docsOutputDir) 111 | } 112 | 113 | private fun getStdlibSchemas(): Pair> { 114 | val release = Release.current() 115 | val schemas = release.standardLibrary().modules() 116 | .map { ModuleSource.uri(it) } 117 | .map(evaluator::evaluateSchema) 118 | return stdlibDocPackageInfo to schemas 119 | } 120 | 121 | private val stdlibDocPackageInfo by lazy { 122 | val source = ModuleSource.modulePath("org/pkl/core/stdlib/doc-package-info.pkl") 123 | DocPackageInfo.fromPkl(evaluator.evaluate(source)) 124 | } 125 | 126 | private val docsiteInfo: DocsiteInfo by lazy { 127 | val source = ModuleSource.modulePath("org/pkl/package_docs/docsite-info.pkl") 128 | DocsiteInfo.fromPkl(evaluator.evaluate(source)) 129 | } 130 | 131 | private fun downloadExistingDocs() { 132 | docsOutputDir.toFile().deleteRecursively() 133 | runCommand(listOf("git", "worktree", "prune"), gitRootDir) 134 | runCommand(listOf("git", "fetch", pklOriginalRemoteName, "+www:www"), gitRootDir) 135 | runCommand(listOf("git", "worktree", "add", docsOutputDir.toString(), "www"), gitRootDir) 136 | } 137 | 138 | private data class ProcessResult(val stdout: String, val stderr: String, val exitValue: Int) 139 | 140 | private fun runCommand(command: List, workingDir: Path): ProcessResult { 141 | val result = runCommandAllowingError(command, workingDir) 142 | if (result.exitValue != 0) { 143 | throw PackageDocException("Failed to run command: ${command.joinToString(" ")}. Got stdout: ${result.stdout}, and stderr: ${result.stderr}") 144 | } 145 | return result 146 | } 147 | 148 | private fun runCommandAllowingError(command: List, workingDir: Path): ProcessResult { 149 | val process = Runtime.getRuntime().exec(command.toTypedArray(), null, workingDir.toFile()) 150 | val stdout = process.inputStream.reader().use { it.readText() } 151 | val stderr = process.errorStream.reader().use { it.readText() } 152 | // Note that this timeout offers little protection against the process running for too long 153 | // because we only get here if/when stdout and stderr are closed. 154 | process.waitFor(10, TimeUnit.SECONDS) 155 | return ProcessResult(stdout, stderr, process.exitValue()) 156 | } 157 | 158 | private val packageResolver by lazy { 159 | PackageResolver.getInstance(SecurityManagers.defaultManager, HttpClient.builder().buildLazily(), IoUtils.getDefaultModuleCacheDir()) 160 | } 161 | 162 | private val currentPklRelease = Release.current().version().toString() 163 | 164 | private val stdlibDependency = DocPackageInfo.PackageDependency( 165 | name = "pkl", 166 | uri = null, 167 | version = currentPklRelease, 168 | sourceCode = URI(Release.current().sourceCode().homepage()), 169 | sourceCodeUrlScheme = Release.current().sourceCode().sourceCodeUrlScheme, 170 | documentation = URI(PklInfo.current().packageIndex.getPackagePage("pkl", currentPklRelease)) 171 | ) 172 | 173 | private fun DependencyMetadata.getPackageDependencies(): List { 174 | return buildList { 175 | for ((_, dependency) in dependencies) { 176 | val metadata = try { 177 | packageResolver.getDependencyMetadata(dependency.packageUri, dependency.checksums) 178 | } catch (e: Exception) { 179 | throw CliException("Failed to fetch dependency metadata for ${dependency.packageUri}: ${e.message}") 180 | } 181 | val packageDependency = DocPackageInfo.PackageDependency( 182 | name = metadata.name, 183 | uri = dependency.packageUri.uri, 184 | version = metadata.version.toString(), 185 | sourceCode = metadata.sourceCode, 186 | sourceCodeUrlScheme = metadata.sourceCodeUrlScheme, 187 | documentation = metadata.documentation 188 | ) 189 | add(packageDependency) 190 | } 191 | add(stdlibDependency) 192 | } 193 | } 194 | 195 | private fun PackageUri.gatherAllModules(): List { 196 | fun PackageAssetUri.gatherModulesRecursively(): List { 197 | val self = this 198 | return buildList { 199 | for (element in packageResolver.listElements(self, null)) { 200 | val elementAssetUri = self.resolve(element.name) 201 | if (element.isDirectory) { 202 | addAll(elementAssetUri.gatherModulesRecursively()) 203 | } else if (element.name.endsWith(".pkl")) { 204 | add(elementAssetUri) 205 | } 206 | } 207 | } 208 | } 209 | return toPackageAssetUri("/").gatherModulesRecursively() 210 | } 211 | 212 | private val evaluator: Evaluator by lazy { 213 | Evaluator.preconfigured() 214 | } 215 | 216 | private fun getSchemasFromPackage(packageUri: PackageUri): Pair>? { 217 | return try { 218 | val docPackageInfo = packageUri.toDocPackageInfo() 219 | val schemas = packageUri.gatherAllModules().mapNotNull { 220 | val schema = try { 221 | evaluator.evaluateSchema(ModuleSource.uri(it.uri)) 222 | } catch (e: Throwable) { 223 | return@mapNotNull null 224 | } 225 | val moduleName = schema.moduleName 226 | val expectedModuleName = docPackageInfo.moduleNamePrefix + it.assetPath.toString().drop(1) 227 | .dropLast(4) 228 | .replace('/', '.') 229 | if (moduleName != expectedModuleName) { 230 | println( 231 | """ 232 | Module ${it.uri} has an incorrect name. Skipping docs. 233 | 234 | Expected: 235 | $expectedModuleName 236 | 237 | Actual: 238 | $moduleName 239 | """.trimIndent() 240 | ) 241 | return null 242 | } 243 | schema 244 | } 245 | docPackageInfo to schemas 246 | } catch (e: Throwable) { 247 | println(""" 248 | Failed to fetch package info for $packageUri: 249 | 250 | ${e.message} 251 | """.trimIndent()) 252 | null 253 | } 254 | } 255 | 256 | private fun PackageUri.toDocPackageInfo(): DocPackageInfo { 257 | val metadataAndChecksum = try { 258 | packageResolver.getDependencyMetadataAndComputeChecksum(this) 259 | } catch (e: PackageLoadError) { 260 | throw CliException("Failed to package metadata for $this: ${e.message}") 261 | } 262 | val metadata = metadataAndChecksum.first 263 | val checksum = metadataAndChecksum.second 264 | return DocPackageInfo( 265 | name = "${uri.authority}${uri.path.substringBeforeLast('@')}", 266 | moduleNamePrefix = "${metadata.name}.", 267 | version = metadata.version.toString(), 268 | importUri = toPackageAssetUri("/").toString(), 269 | uri = uri, 270 | authors = metadata.authors, 271 | issueTracker = metadata.issueTracker, 272 | dependencies = metadata.getPackageDependencies(), 273 | overview = metadata.description, 274 | extraAttributes = mapOf( 275 | "Checksum" to checksum.sha256 276 | ), 277 | sourceCode = metadata.sourceCode, 278 | sourceCodeUrlScheme = metadata.sourceCodeUrlScheme 279 | ) 280 | } 281 | } 282 | -------------------------------------------------------------------------------- /src/main/resources/org/pkl/package_docs/docsite-info.pkl: -------------------------------------------------------------------------------- 1 | //===----------------------------------------------------------------------===// 2 | // Copyright © 2024 Apple Inc. and the Pkl project authors. All rights reserved. 3 | // 4 | // Licensed under the Apache License, Version 2.0 (the "License"); 5 | // you may not use this file except in compliance with the License. 6 | // You may obtain a copy of the License at 7 | // 8 | // https://www.apache.org/licenses/LICENSE-2.0 9 | // 10 | // Unless required by applicable law or agreed to in writing, software 11 | // distributed under the License is distributed on an "AS IS" BASIS, 12 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | // See the License for the specific language governing permissions and 14 | // limitations under the License. 15 | //===----------------------------------------------------------------------===// 16 | /// Documentation for packages maintained by the Pkl team 17 | amends "pkl:DocsiteInfo" 18 | 19 | title = "Packages" 20 | --------------------------------------------------------------------------------