1. Project Overview & Quickstart (GradleUp/LICENSE)
LICENSE
Open-source repository GradleUp/LICENSE
Repository Details
- Repository: GradleUp/LICENSE
- Primary Language: Code
Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.
2. Official Technical Reference & Guides (GradleUp/GradleUp.github.io)
File: README.md
This repository hosts a GradleUp website.
It includes the styles and some top-level content.
Project documentation and other information are sourced from other repositories.
What is GradleUp?
GradleUp is an umbrella GitHub organization created by, and for, the community.
GradleUp focuses on simplifying building Java, Kotlin and Android projects.
On our menu: Gradle plugins, developer tools and best practices.
GradleUp is not affiliated with, or sponsored by Gradle, Inc. Gradle Up is an independent organization and its projects, plugins, and products are not affiliated with or sponsored by Gradle, Inc. in any way.
License
This site by the GradleUp team and contributors is licensed under CC BY 4.0
Imported content from external repositories might have other licenses.
Contributing
Any contributions, typo fixes and patches are welcome!
The content is located inside the project repositories.
If you want to contribute to the GradleUp site,
see the guidelines here
File: docs/community/governance.md
GradleUp Governance Charter
What is GradleUp?
GradleUp is a volunteer-driven umbrella GitHub organization
focusing on simplifying developer experience with Gradle Build Tool (a.k.a. Gradle),
in particular for Java, Kotlin and Android projects.
We host components and ensure their long-term sustainability.
Our scope includes all things that help to achieve great user and developer experience when working with Gradle.
It includes but not limited to plugins, developer tools, integrations, documentation or community content.
Formal Side
The GradleUp organization is a volunteer driven community
operating in a public interest in a non-profit mode and
providing no commercial services.
There is no formal legal entity behind GradleUp.
As it is written in the Apache License v2:
Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
Gradle and the Gradlephant logo (the "Gradle Marks") are registered trademarks of Gradle, Inc. and/or its subsidiaries.
In the GradleUp organization, "Gradle" typically means "Gradle Build Tool" and does not reference Gradle Inc. and/or its subsidiaries.
All references to the trademark represent a fair use,
and do not imply endorsement.
Structure
The project is led by a small team of passionate Gradle users and contributors.
This GradleUp Team is to be considered as a top governance and steering entity for the project.
The project also includes maintainers and contributors.
Roles
- Contributor - any individual who participates in the community and
adds value to in one form or another,
including but not limited to code, documentation, automation, advocacy or
community support. - Team Member -
A GradleUp contributor listed on the GradleUp Team page.
They participate in the project steering as whole.
New team members are added by the decision of the current team members. - Org Admin - A team member with administrative access to the GitHub
organization and/or other community resources.
Permissions and access are granted based on the decision of the current team members. - Maintainer - A GradleUp contributor who maintains a component hosted on GradleUp.
It includes roles Triage or above.
Components may explicitly or implicitly introduce more Maintainer sub-roles.
Decision Making
The decisions are made by the GradleUp Team based on consensus and common sense.
We intend to make decision making fast and light-weight,
with minimum overhead when a consensus exists.
Most of the decisions are discussed and made in
public communication channels.
It is expected that all contributors and end users are able to participate to the decisions.
Some exceptional decisions,
for example Code of Conduct discussions,
may be done in private.
Components Governance
Component Ownership
Maintainers have full control of technical decisions and processes within their components.
Apart from the requirements documented in the Hosting Guidelines,
Maintainers are free to define the governance processes within their repositories,
to add collaborators to the projects,
or to implement automation and release process as they deem beneficial.
All hosted components remain a subject to GradleUp Code of Conduct,
and they must adhere to some security and hosting rules documented in the Hosting Guidelines.
The recommendations and best practices remain optional.
Hosting New Components
New Gradle related projects can be potentially hosted on GradleUp.
It includes transferring the project to GradleUp,
and ensuring quality and sustainability of the project.
See the Hosting New Projects page for more information.
Transferring Ownership
Should a Maintainer explicitly move-on and put a project for adoption,
or become unresponsive for a long period of time,
the GradleUp Team can re-assign ownership of the project to ensure the
continuity of the component.
A best possible effort should be made to reach out to the maintainer beforehand.
Open Source Commitment
In GradleUp, we are committed to open source.
We intend to do most of the work in public,
and to have publicly open communication channels to discuss the changes and the strategy.
We reserve the right to do some work in private when it is required to
ensure confidentiality and safety of GradleUp contributors and users.
Possible examples include:
- Vulnerability reporting, security patches and advisory preparetion.
See the Security Policy - Code of Conduct escalations, investigation and follow-ups
- Distribution of physical assets like swag
Licenses
Within our resources we host ONLY open source components
under the OSI-compliant licenses.
The non-code components under the GradleUp organization on GitHub and created by the GradleUp team and contributors, unless explicitly specificed otherwise, are licensed under CC BY 4.0
Code of Conduct
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
Read our full Code of Conduct.
File: docs/community/hosting.md
Hosting New Projects on GradleUp
New Gradle related projects can be potentially hosted on GradleUp.
It includes transferring the project to GradleUp,
and ensuring quality and sustainability of the project.
Hosting Process
At the moment, there is no documented process for hosting new components.
The criteria below are general practices,
and they will be extended over time.
The decision will be made by the GradleUp Team on a case by case basis.
To request the transfer and initiate the discussion, contact the team.
Criteria
The general criteria for hosting a project are:
- The project has value to the ecosystem and fits into the GradleUp scope.
- The project must be open source and licensed under one of the
OSI-approved open source licenses. - The project follows the best practices for creating Gradle plugins and components.
- The requesting contributors are willing to continue maintenance of the project
after the transfer. - The requesting contributors are willing to ensure sustainability of their project,
and fine with it being transferred to another maintainer should they become inactive as documented in the Governance Charter.
File: docs/community/participate.md
title: Participate in GradleUp
Subscribe to the GradleUp news,
join the discussions on Slack and GitHub issues
Subscribe to the GradleUp news, join the discussions on Slack and GitHub issues.
All code and non-code contributions are welcome!
News
We have a blog on blog.gradleup.com.
There we will be publishing the key updates on what's up in GradleUp.
You can also subscribe to the blog as a newsletter
or RSS feed.
Guest posts by GradleUp users and component maintainers are welcome, too!
Reach out to us on Slack if interested
GitHub Issues
Each project repository has GitHub Issues enabled.
Please raise bugs and discuss feature requests there.
Slack
We have a #gradleup public channel on the
Gradle Community Slack.
This chat is used for real-time development and end user discussions.
For longer-term discussions, e.g. architecture proposals or feature requests,
it is highly recommended to use GitHub Issues in the respective repositories.
The following components have custom channels:
#dev-shadow-plugin- development of the Shadow Plugin.
In the future, we may introduce more channels.
Slack Archive
Gradle Community Slack uses the free plan,
so the history of #gradleup is limited to 3 months.
You can find the communications archive for previous dates
here.
File: docs/community/team.md
GradleUp Team
The project is led by a small team of passionate Gradle users and contributors.
The team is decentralized and decisions are made based on consensus and common sense.
Learn more in the Governance Document.
Members
- Alex Nordlund (@deepy)
- Jean-Michel Fayard (@jmfayard)
- Louis CAD (@LouisCAD)
- Martin Bonnin (@martinbonnin)
- Pablisco (@pablisco)
- Said Tahsin Dane (@tasomaniac)
- Nicola Corti (@cortinico)
Contact the Team
For now, we use DMs on the Kotlinlang Slack, or the Gradle Community Slack.
Public communication channels are to be established soon.
File: projects/README.md
GradleUp Projects
The key projects are listed below.
You can find the full list of projects being developed by the team
on the GitHub organization
Gradle Plugins
- Tapmoc -
Makes it easy to handle your Java & Kotlin compatibility flags - Auto Manifest -
GeneratesAndroidManifest.xmlin simple libraries so that you don't have to - Gradle static analysis plugin -
A Gradle plugin to easily apply the same setup of static analysis tools
across different Android, Java or Kotlin projects. - Gratatouille -
Gratatouille is an opinionated framework to build Gradle plugins. Write pure Kotlin functions and the Gratatouille KSP processor generates tasks, workers and wiring code for you. - Gr8 -
Gr8 makes it easy to shadow, shrink, and minimize your jars. - Librarian -
Librarian is a library to help building Kotlin libraries. - Maven Sympathy -
A small Gradle plugin that checks that your project dependencies play nice with Maven resolution strategy - NMCP (New Maven Central Publishing) -
A plugin that uses the new Central Portal publisher API to publish to Maven Central. - Shadow -
Gradle plugin to create fat/uber JARs, apply file transforms, and relocate packages for applications and libraries.
Gradle version of Maven's Shade plugin.
Hosting New Projects
New Gradle related projects can be potentially hosted on GradleUp.
It includes transferring the project to GradleUp,
and ensuring quality and sustainability of the project.
See the New Projects Hosting Guide for more info.