From 999f35bf548a6df4f27a42af30d80d3b5518e137 Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Wed, 6 Mar 2024 10:26:03 +0100 Subject: [PATCH 1/6] Add license infiormation --- LICENSE.txt | 437 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 7 + 2 files changed, 444 insertions(+) create mode 100644 LICENSE.txt diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 00000000..cbe5ad16 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,437 @@ +Attribution-NonCommercial-ShareAlike 4.0 International + +======================================================================= + +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + +======================================================================= + +Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International +Public License + +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution-NonCommercial-ShareAlike 4.0 International Public License +("Public License"). To the extent this Public License may be +interpreted as a contract, You are granted the Licensed Rights in +consideration of Your acceptance of these terms and conditions, and the +Licensor grants You such rights in consideration of benefits the +Licensor receives from making the Licensed Material available under +these terms and conditions. + + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright + and Similar Rights in Your contributions to Adapted Material in + accordance with the terms and conditions of this Public License. + + c. BY-NC-SA Compatible License means a license listed at + creativecommons.org/compatiblelicenses, approved by Creative + Commons as essentially the equivalent of this Public License. + + d. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + e. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + f. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + g. License Elements means the license attributes listed in the name + of a Creative Commons Public License. The License Elements of this + Public License are Attribution, NonCommercial, and ShareAlike. + + h. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + i. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + j. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + k. NonCommercial means not primarily intended for or directed towards + commercial advantage or monetary compensation. For purposes of + this Public License, the exchange of the Licensed Material for + other material subject to Copyright and Similar Rights by digital + file-sharing or similar means is NonCommercial provided there is + no payment of monetary compensation in connection with the + exchange. + + l. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + m. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + n. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part, for NonCommercial purposes only; and + + b. produce, reproduce, and Share Adapted Material for + NonCommercial purposes only. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. Additional offer from the Licensor -- Adapted Material. + Every recipient of Adapted Material from You + automatically receives an offer from the Licensor to + exercise the Licensed Rights in the Adapted Material + under the conditions of the Adapter's License You apply. + + c. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties, including when + the Licensed Material is used other than for NonCommercial + purposes. + + +Section 3 -- License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified + form), You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + b. ShareAlike. + + In addition to the conditions in Section 3(a), if You Share + Adapted Material You produce, the following conditions also apply. + + 1. The Adapter's License You apply must be a Creative Commons + license with the same License Elements, this version or + later, or a BY-NC-SA Compatible License. + + 2. You must include the text of, or the URI or hyperlink to, the + Adapter's License You apply. You may satisfy this condition + in any reasonable manner based on the medium, means, and + context in which You Share Adapted Material. + + 3. You may not offer or impose any additional or different terms + or conditions on, or apply any Effective Technological + Measures to, Adapted Material that restrict exercise of the + rights granted under the Adapter's License You apply. + + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database for NonCommercial purposes + only; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material, + including for purposes of Section 3(b); and + + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. + +======================================================================= + +Creative Commons is not a party to its public +licenses. Notwithstanding, Creative Commons may elect to apply one of +its public licenses to material it publishes and in those instances +will be considered the “Licensor.” The text of the Creative Commons +public licenses is dedicated to the public domain under the CC0 Public +Domain Dedication. Except for the limited purpose of indicating that +material is shared under a Creative Commons public license or as +otherwise permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the +use of the trademark "Creative Commons" or any other trademark or logo +of Creative Commons without its prior written consent including, +without limitation, in connection with any unauthorized modifications +to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For +the avoidance of doubt, this paragraph does not form part of the +public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/README.md b/README.md index 05d16bee..39ef024d 100644 --- a/README.md +++ b/README.md @@ -99,3 +99,10 @@ javaLibrary { - [dedicated category](https://discuss.gradle.org/c/help-discuss/declarative-gradle/38) Gradle Forums See [Gradle Community Resources](https://gradle.org/resources/) for the links to the channels. + +## License + +All text/documentation content is open source and licensed under the +[Creative Commons Attribution-NonCommercial-ShareAlike 4.0 License](./LICENSE.txt). +Some code samples may be licensed under the Apache License v2.0, +or other permissive OSI-compliant licenses. From 616e0f7c0b8b147c46e8f35ffc0fd7434cb45632 Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Wed, 6 Mar 2024 10:34:27 +0100 Subject: [PATCH 2/6] Merge in changes from the community site --- README.md | 79 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 45 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 39ef024d..3f16a8cf 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Declarative Gradle Prototypes +# Declarative Gradle This repository contains prototypes and public examples of the [Declarative Gradle](https://blog.gradle.org/declarative-gradle) @@ -7,17 +7,50 @@ syntax and project definitions. ## Disclaimer _Declarative Gradle_ is an experimental project. -At this point, no compatibility is guaranteed, -as well as there is no commitment to the DSL syntax +Currently, no compatibility is guaranteed, and there is no commitment to the DSL syntax and available features. -More information will be released soon +More information will be released soon. Any feedback is welcome! ## Concept -Below a very brief example of how the Declarative Gradle syntax may look like. This example shows the definition of a Java library that targets both Java 11 and 21: +Here are a few very brief examples of what the Declarative Gradle syntax may look like. +As noted above, this syntax is experimental and might change during the experiment. + +### Java libraries + +A typical Java library, which targets a single version of Java, might look like this: + +```kotlin +javaLibrary { + publishedAs("my-group:my-lib:2.0") + + dependencies { + api("some:lib:1.2") + implementation(projects.someLib) + } + + // This library targets Java 21 only + java(21) + + tests { + unit { + dependencies { + implementation("some:other-lib:1.4") + } + } + } +} +``` + +### Multi-target projects + +This example shows the definition of a Java library that targets both Java 11 and 21: + +
+ Show Code ```kotlin // Declare the type of software that the project produces @@ -65,29 +98,14 @@ javaLibrary { } ``` -A typical Java library, which targets a single version of Java, might look like this: +
-```kotlin -javaLibrary { - publishedAs("my-group:my-lib:2.0") - - dependencies { - api("some:lib:1.2") - implementation(projects.someLib) - } - - // This library targets Java 21 only - java(21) +## License - tests { - unit { - dependencies { - implementation("some:other-lib:1.4") - } - } - } -} -``` +All text/documentation content is open source and licensed under the +[Creative Commons Attribution-NonCommercial-ShareAlike 4.0 License](./LICENSE.txt). +Some code samples may be licensed under the Apache License v2.0, +or other permissive OSI-compliant licenses. ## Read More @@ -95,14 +113,7 @@ javaLibrary { ## Discuss -- `#declarative-gradle` channel on the community Slack +- `#declarative-gradle` channel on the [Gradle Community Slack](https://gradle.org/slack-invite) - [dedicated category](https://discuss.gradle.org/c/help-discuss/declarative-gradle/38) Gradle Forums See [Gradle Community Resources](https://gradle.org/resources/) for the links to the channels. - -## License - -All text/documentation content is open source and licensed under the -[Creative Commons Attribution-NonCommercial-ShareAlike 4.0 License](./LICENSE.txt). -Some code samples may be licensed under the Apache License v2.0, -or other permissive OSI-compliant licenses. From cc7740fa7aff449dcc837c180e155a5ad770c003 Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Wed, 6 Mar 2024 10:43:22 +0100 Subject: [PATCH 3/6] Add prototype references to README --- README.md | 10 ++++++++++ early-prototypes/README.md | 19 ++++++++++++++----- unified-prototype/README.md | 4 ++-- 3 files changed, 26 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 3f16a8cf..0f47dff4 100644 --- a/README.md +++ b/README.md @@ -100,6 +100,16 @@ javaLibrary { +## Prototypes + +Here are the experimental prototypes +currently available for initial review. +They are not ready for evaluation at the moment: + +- [Unified Prototype](./unified-prototype/README.md) - prototypes of plugins for JVM, Android, and KMP projects built using "unified" plugins that all utilize a similar model and implemented using the Declarative DSL +- [Other Early prototypes](./early-prototypes/README.md) - +Initial prototypes created for feedback and discussion purposes. + ## License All text/documentation content is open source and licensed under the diff --git a/early-prototypes/README.md b/early-prototypes/README.md index 7b20a261..20994f1d 100644 --- a/early-prototypes/README.md +++ b/early-prototypes/README.md @@ -1,6 +1,15 @@ -# Early prototypes +# Declarative Gradle - Early prototypes -## [Android](android/README.md) -## [Java projects](single-target/README.md) -## [Kotlin Multiplatform projects](kotlin-multiplatform/README.md) -## [Settings](workspace-settings/README.md) +Here is a list of the early prototypes we created for Declarative Gradle. see the [Unified Prototypes](../unified-prototype/README.md) directory for more recent developments. + +- [Android](android/README.md) +- [Java projects](single-target/README.md) +- [Kotlin Multiplatform projects](kotlin-multiplatform/README.md) +- [Settings](workspace-settings/README.md) + +## Disclaimer + +All prototypes in this directory are experimental, +mostly for syntax evaluation and initial feedback. +They may compile or not. +No compatibility or other commitment is implied. diff --git a/unified-prototype/README.md b/unified-prototype/README.md index 9d52dfbd..aed621bb 100644 --- a/unified-prototype/README.md +++ b/unified-prototype/README.md @@ -1,6 +1,6 @@ -# Unified Plugin Prototypes +# DEclarative Gradle - Unified Plugin Prototypes -This directory contains prototypes of plugins for JVM, Android and KMP projects built using "unified" plugins that all utilize a similar model and are implemented using the Declarative DSL. +This directory contains prototypes of plugins for JVM, Android, and KMP projects built using "unified" plugins that all utilize a similar model and are implemented using the Declarative DSL. Currently, these different ecosystems still apply distinct plugins, but those plugins all share a common `plugin-common` dependency, which will gradually grow to contain more functionality. From 7b7c9dbf51f5c26ff5c95dfd4b9758b7d05e7628 Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Wed, 6 Mar 2024 10:48:03 +0100 Subject: [PATCH 4/6] Add Contributing stub with the disclaimers --- README.md | 3 ++- docs/CONTRIBUTING.md | 13 +++++++++++++ unified-prototype/README.md | 2 +- 3 files changed, 16 insertions(+), 2 deletions(-) create mode 100644 docs/CONTRIBUTING.md diff --git a/README.md b/README.md index 0f47dff4..6dae10cc 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ Currently, no compatibility is guaranteed, and there is no commitment to the DSL and available features. More information will be released soon. Any feedback is welcome! +See more on the [Contributor Guide](./docs/CONTRIBUTING.md). @@ -124,6 +125,6 @@ or other permissive OSI-compliant licenses. ## Discuss - `#declarative-gradle` channel on the [Gradle Community Slack](https://gradle.org/slack-invite) -- [dedicated category](https://discuss.gradle.org/c/help-discuss/declarative-gradle/38) Gradle Forums +- [Dedicated category](https://discuss.gradle.org/c/help-discuss/declarative-gradle/38) Gradle Forums See [Gradle Community Resources](https://gradle.org/resources/) for the links to the channels. diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 00000000..e2faee47 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,13 @@ +# Contributing to Declarative Gradle + +_Declarative Gradle_ is an experimental project. +Currently, it is not ready for tinkering or wide adoption. +Discussion and sharing feedback is the recommended way of participation at the moment. + +## Share Feedback + +While the project is in early stages, +initial feedback on DSL and use-cases will be appreciated! + +- `#declarative-gradle` channel on the [Gradle Community Slack](https://gradle.org/slack-invite) +- [Dedicated category](https://discuss.gradle.org/c/help-discuss/declarative-gradle/38) Gradle Forums diff --git a/unified-prototype/README.md b/unified-prototype/README.md index aed621bb..87cc553f 100644 --- a/unified-prototype/README.md +++ b/unified-prototype/README.md @@ -1,4 +1,4 @@ -# DEclarative Gradle - Unified Plugin Prototypes +# Declarative Gradle - Unified Plugin Prototypes This directory contains prototypes of plugins for JVM, Android, and KMP projects built using "unified" plugins that all utilize a similar model and are implemented using the Declarative DSL. From 8a2cbbccaeef86c560ca9ed32a5ff4407d005c17 Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Wed, 6 Mar 2024 11:00:45 +0100 Subject: [PATCH 5/6] Add small manifesto to the beginning of README --- README.md | 31 ++++++++++++++++++++++++++----- 1 file changed, 26 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6dae10cc..2e62ccf6 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,29 @@ # Declarative Gradle -This repository contains prototypes and public examples -of the [Declarative Gradle](https://blog.gradle.org/declarative-gradle) -syntax and project definitions. +At Gradle, part of our vision is to provide an elegant and extensible declarative build language +that enables expressing any build in a clear and understandable way. +We are working on _Declarative Gradle_ to realize that part of the vision. +This is an experimental project, stay tuned for updates! + +Learn more in the [Declarative Gradle Announcement](https://blog.gradle.org/declarative-gradle) +blog post. + +## Key Principles + +- **Ease of use** for regular software developers. + Software developers should be able to define any software and build their projects + without the need to understand the details of how the build system works. +- **Complete flexibility** for build engineers and advanced users. + Experienced Gradle users should maintain the current level of flexibility and be able + to automate a wide range of software build automation scenarios with custom build logic. +- **Excellent IDE integration.** + Importing the software project to the IDE and interacting with it should be fast and fully reliable. + IDEs and other tools should be able to change the software definition automatically or through UI reliably. + +We implement those principles through a _declarative DSL_ which is at the moment based on Kotlin. +The [Declarative Gradle Announcement](https://blog.gradle.org/declarative-gradle) +outlines more details about the project and the new +Declarative DSL we are building. ## Disclaimer @@ -20,7 +41,7 @@ See more on the [Contributor Guide](./docs/CONTRIBUTING.md). Here are a few very brief examples of what the Declarative Gradle syntax may look like. As noted above, this syntax is experimental and might change during the experiment. -### Java libraries +### Java Libraries A typical Java library, which targets a single version of Java, might look like this: @@ -46,7 +67,7 @@ javaLibrary { } ``` -### Multi-target projects +### Multi-target Projects This example shows the definition of a Java library that targets both Java 11 and 21: From bd23c87c9736e621c273f3e5f3db8fbbd2812116 Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Wed, 6 Mar 2024 11:19:39 +0100 Subject: [PATCH 6/6] Add Slack badges --- README.md | 2 ++ docs/CONTRIBUTING.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/README.md b/README.md index 2e62ccf6..f8384aa0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Declarative Gradle +[![a](https://img.shields.io/badge/slack-%23declarative_gradle-brightgreen?style=flat&logo=slack)](https://gradle.org/slack-invite) + At Gradle, part of our vision is to provide an elegant and extensible declarative build language that enables expressing any build in a clear and understandable way. We are working on _Declarative Gradle_ to realize that part of the vision. diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index e2faee47..bc96e2fd 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,5 +1,7 @@ # Contributing to Declarative Gradle +[![a](https://img.shields.io/badge/slack-%23declarative_gradle-brightgreen?style=flat&logo=slack)](https://gradle.org/slack-invite) + _Declarative Gradle_ is an experimental project. Currently, it is not ready for tinkering or wide adoption. Discussion and sharing feedback is the recommended way of participation at the moment.