blob: 34b1750d14918c4f0465cf0ac12248c31dacb9e4 [file] [log] [blame] [view]
# Project/Module Creator
This script will create a new project/module using a groupId and artifactId.
It will use the groupId and artifactId to best guess which configuration
is most appropriate for the project/module you are creating.
### Using the script
```bash
./create_project.py androidx.foo foo-bar
```
### Todos **after** project creation
1. [OWNERS] Check that the OWNERS file is in the correct place
2. [OWNERS] Add your name (and others) to the OWNERS file
3. [build.grade] Check that the correct library version is assigned
4. [build.grade] Fill out the project/module name
5. [package-info.java] Fill out the project/module package-info.java file
### Project/Module Types
The script leverages buildSrc/public/src/main/kotlin/androidx/build/LibraryType.kt
to create the recommended defaults for your project. However, you can override
the options to best fit your requirements.
### Testing the script
Generic project integration test
```bash
./create_project.py androidx.foo.bar bar-qux
```
Script test suite
```bash
./test_project_creator.py
```