{"id":14987805,"url":"https://github.com/apache/pekko-sbt-paradox","last_synced_at":"2025-10-19T11:32:41.292Z","repository":{"id":65749185,"uuid":"586334582","full_name":"apache/pekko-sbt-paradox","owner":"apache","description":"Theme and sbt-paradox settings used by Pekko projects","archived":false,"fork":false,"pushed_at":"2025-01-03T15:50:44.000Z","size":118,"stargazers_count":5,"open_issues_count":3,"forks_count":7,"subscribers_count":14,"default_branch":"main","last_synced_at":"2025-01-30T10:34:34.959Z","etag":null,"topics":["documentation","markdown","paradox","pekko","pekko-sbt-paradox","sbt","themes"],"latest_commit_sha":null,"homepage":"https://pekko.apache.org/","language":"StringTemplate","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apache.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-07T19:07:33.000Z","updated_at":"2025-01-03T15:50:49.000Z","dependencies_parsed_at":"2023-12-24T19:27:19.414Z","dependency_job_id":"612c4874-bb74-461a-9d5e-391bebc846d5","html_url":"https://github.com/apache/pekko-sbt-paradox","commit_stats":{"total_commits":105,"total_committers":8,"mean_commits":13.125,"dds":0.6666666666666667,"last_synced_commit":"4658a03af5351ffe597271f7764af8992dc6f275"},"previous_names":["apache/pekko-sbt-paradox","apache/incubator-pekko-sbt-paradox"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fpekko-sbt-paradox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fpekko-sbt-paradox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fpekko-sbt-paradox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fpekko-sbt-paradox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apache","download_url":"https://codeload.github.com/apache/pekko-sbt-paradox/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237125447,"owners_count":19259286,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","markdown","paradox","pekko","pekko-sbt-paradox","sbt","themes"],"created_at":"2024-09-24T14:15:28.968Z","updated_at":"2025-10-19T11:32:35.981Z","avatar_url":"https://github.com/apache.png","language":"StringTemplate","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!--\n  ~ Licensed to the Apache Software Foundation (ASF) under one or more\n  ~ contributor license agreements.  See the NOTICE file distributed with\n  ~ this work for additional information regarding copyright ownership.\n  ~ The ASF licenses this file to You under the Apache License, Version 2.0\n  ~ (the \"License\"); you may not use this file except in compliance with\n  ~ the License.  You may obtain a copy of the License at\n  ~\n  ~    http://www.apache.org/licenses/LICENSE-2.0\n  ~\n  ~ Unless required by applicable law or agreed to in writing, software\n  ~ distributed under the License is distributed on an \"AS IS\" BASIS,\n  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n  ~ See the License for the specific language governing permissions and\n  ~ limitations under the License.\n  ~\n  --\u003e\n  \n# Pekko SBT Paradox\n\nThis plugin is intended to extend the [sbt-paradox](https://github.com/lightbend/paradox) plugin with some settings\nalong with providing the Apache Pekko theme.\n\nIt is intended as a shared doc theme for the [Apache Pekko](https://github.com/apache/?q=pekko\u0026type=all\u0026language=\u0026sort=)\numbrella of projects, and not as a public theme to use on \"any\" project.\n\n## Usage\n\n### JDK 1.8 (only)\n\nThe project intentionally supports JDK 1.8 by default since its built against\n[sbt-paradox/sbt-paradox-theme 0.9.2](https://github.com/apache/pekko-sbt-paradox/blob/main/project/plugins.sbt#L20-L21)\nso you can just include it like this\n\n```sbt\naddSbtPlugin(\"org.apache.pekko\" % \"sbt-paradox-pekko\" % \"\u003cversion\u003e\")\n```\n\n\u003e **_NOTE:_** If you happen to be using sbt-paradox plugins aside from\n\u003e * sbt-web\n\u003e * sbt-paradox-apidoc\n\u003e * sbt-paradox-project-info\n\u003e you need to use an `excludesAll` statement on `addSbtPlugin` to remove the\n\u003e resolved dependencies that rely on JDK 11+, i.e. if you need to use\n\u003e sbt-site-paradox you would do the following\n\u003e ```sbt\n\u003e addSbtPlugin((\"com.github.sbt\" % \"sbt-site-paradox\" % \"1.5.0\").excludeAll(\n\u003e \"com.lightbend.paradox\", \"sbt-paradox\"))\n\u003e ```\n\n### JDK 11+\n\nWith JDK 11 or later you need to explicitly override the sbt-paradox/sbt-paradox-theme\nversions to use the 10.6.x (or newer) series, i.e.\n\n```sbt\naddSbtPlugin(\"org.apache.pekko\" % \"sbt-paradox-pekko\" % \"\u003cversion\u003e\")\naddSbtPlugin(\"com.lightbend.paradox\" % \"sbt-paradox\" % \"0.10.6\")\naddSbtPlugin(\"com.lightbend.paradox\" % \"sbt-paradox-theme\" % \"0.10.6\")\n```\n\nEnable it instead of the upstream ParadoxPlugin:\n```sbt\nimport org.apache.pekko.PekkoParadoxPlugin\n\nenablePlugins(PekkoParadoxPlugin)\n```\n\nFor more settings refer to the [Paradox documentation](https://developer.lightbend.com/docs/paradox/latest/)\n\n## Testing\n\nWhen you have made changes to pekko-sbt-paradox, you can test it locally with:\n\n```\nsbt publishLocal sbtPlugin/scripted\n```\n\nThis should show:\n\n```\nPausing in /tmp/sbt_e457458e/simple\nPress enter to continue.\n```\n\n## Building from Source\n\n### Prerequisites\n- Make sure you have installed a Java Development Kit (JDK) version 8.\n- Make sure you have [sbt](https://www.scala-sbt.org/) installed and using this JDK.\n\n### Running the Build\n- Open a command window and change directory to your preferred base directory\n- Use git to clone the [repo](https://github.com/apache/pekko-sbt-paradox) or download a source release from https://pekko.apache.org (and unzip or untar it, as appropriate)\n- Change directory to the directory where you installed the source (you should have a file called `build.sbt` in this directory)\n- `sbt compile` compiles the main source for project default version of Scala (2.13)\n- `sbt test` will compile the code and run the unit tests\n- `sbt package` will build the jars\n    - the jars will built into target dirs of the various modules\n    - for the the 'plugin' module, the jar will be built to `plugin/target/scala-2.12/sbt-1.0/`\n- `sbt publishLocal` will push the jars to your local Apache Ivy repository\n- `sbt publishM2` will push the jars to your local Apache Maven repository\n- `sbt sourceDistGenerate` will generate source release to `target/dist/`\n- The version number that appears in filenames and docs is derived, by default. The derived version contains the most git commit id or the date/time (if the directory is not under git control). \n    - You can set the version number explicitly when running sbt commands\n        - eg `sbt \"set ThisBuild / version := \\\"1.0.0\\\"; sourceDistGenerate\"`  \n    - Or you can add a file called `version.sbt` to the same directory that has the `build.sbt` containing something like\n        - `ThisBuild / version := \"1.0.0\"` \n\n## Community\n\nThere are several ways to interact with the Pekko community:\n\n- [GitHub discussions](https://github.com/apache/pekko/discussions): for questions and general discussion.\n- [Pekko dev mailing list](https://lists.apache.org/list.html?dev@pekko.apache.org): for Pekko development discussions.\n- [Pekko users mailing list](https://lists.apache.org/list.html?users@pekko.apache.org): for Pekko user discussions.\n- [GitHub issues](https://github.com/apache/pekko-sbt-paradox/issues): for bug reports and feature requests. Please search the existing issues before creating new ones. If you are unsure whether you have found a bug, consider asking in GitHub discussions or the mailing list first.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fpekko-sbt-paradox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapache%2Fpekko-sbt-paradox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fpekko-sbt-paradox/lists"}