1.2. Project configuration
Up: 1. Introduction to ATR
Prev: 1.1. Getting started
Next: 1.3. Release manager setup
Sections:
Project configuration
You can manage project metadata in ATR or in the project block of your repository's .asf.yaml file. Committee members can use Export .asf.yaml on the project page to get the current configuration as a starting point.
For example, the Maven Filtering project has the following metadata:
project:
metadata:
key: maven-filtering
committee: maven
name: Apache Maven Filtering
key is the project identifier used in ATR URLs and API requests. committee identifies the committee responsible for the project. name is the project's full display name and must start with Apache and a space. The web form adds this prefix automatically, but .asf.yaml synchronization does not.
A name must be supplied when creating a project. When updating an existing project, omitting the name preserves its current value. If you use doap: to supply metadata, the name comes from the DOAP project's <name> element and must include the prefix there. A name supplied alongside doap: is ignored.
Synchronization is enabled by default and runs from the repository's default branch. When enabled, the next push imports the supplied values, overwriting manual changes to those fields in ATR. Correct the name in .asf.yaml or its linked DOAP file so that subsequent imports preserve the correction.
While the most recent update to a project came from .asf.yaml, ATR shows a notice on the project page to anyone who can edit it, and repeats it when they save a change there. The notice clears once somebody edits the project in ATR, and returns with the next push.
See the asfyaml project metadata reference for the complete configuration format, release policy settings, and synchronization options.