Apache Yetus
Clone or download
aw-was-here YETUS-783. download links for 0.8.0 and 0.9.0 are different
Signed-off-by: Sean Busbey <busbey@apache.org>
Latest commit aa16845 Jan 18, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci YETUS-723. Overhaul the Docker support for 2018 Dec 16, 2018
Formula YETUS-767. add 0.9.0 official; remove 0.6.0 Jan 18, 2019
asf-site-src YETUS-783. download links for 0.8.0 and 0.9.0 are different Jan 18, 2019
audience-annotations-component YETUS-767. Bump master version to 0.10.0-SNAPSHOT Jan 10, 2019
hooks YETUS-708. Clean up the source Dec 13, 2018
precommit YETUS-767. Bump master version to 0.10.0-SNAPSHOT Jan 10, 2019
releasedocmaker YETUS-767. Bump master version to 0.10.0-SNAPSHOT Jan 10, 2019
shelldocs YETUS-767. Bump master version to 0.10.0-SNAPSHOT Jan 10, 2019
yetus-assemblies YETUS-767. Bump master version to 0.10.0-SNAPSHOT Jan 10, 2019
yetus-dist YETUS-767. Bump master version to 0.10.0-SNAPSHOT Jan 10, 2019
yetus-maven-plugin YETUS-770. yetus-maven-plugin build helper adds source files, not dirs Jan 10, 2019
yetus-minimaven-plugin YETUS-767. Bump master version to 0.10.0-SNAPSHOT Jan 10, 2019
.gitattributes HADOOP-10040. svn propset to native line endings on Windows files. Co… Oct 14, 2013
.gitignore YETUS-15. build environment Nov 11, 2018
.gitlab-ci.yml Comprehensive CI system patch Dec 13, 2018
.hadolint.yaml YETUS-714. Support for yamllint Dec 13, 2018
.jshintignore YETUS-35. add support for jshint Dec 10, 2018
.pylintrc YETUS-361. Use Google's pylintrc file. Apr 2, 2016
.rubocop.yml YETUS-714. Support for yamllint Dec 13, 2018
.travis.yml Comprehensive CI system patch Dec 13, 2018
Dockerfile YETUS-739. yetus' mvn site fails when run with built-in dockerfile Dec 23, 2018
Jenkinsfile YETUS-752. Jenkinsfile: only send mail to dev@ on apache.org (addendum) Jan 9, 2019
LICENSE YETUS-15. build environment Nov 11, 2018
NOTICE YETUS-768. Update year to 2019 Jan 10, 2019
README.md YETUS-739. yetus' mvn site fails when run with built-in dockerfile Dec 23, 2018
pom.xml YETUS-767. Bump master version to 0.10.0-SNAPSHOT Jan 10, 2019
start-build-env.sh YETUS-739. yetus' mvn site fails when run with built-in dockerfile Dec 23, 2018

README.md

Apache Yetus

Apache Yetus is a collection of libraries and tools that enable contribution and release process for software projects.

Components

Here is a list of the major components:

  • Website source Holds our documentation, which is presented via our website.
  • Precommit Precommit provides robust tools to deal with contributions, including applying patches from a variety of project sources and evaluating them against project norms via a system of plugins. See the precommit overview to get started working with precommit.
  • Audience Annotations Audience Annotations allows projects to use Java Annotations to delineate public and non-public parts of their APIs. It also provides doclets to generate javadocs filtered by the intended audience. Currently builds with Maven 3.2.0+.
  • Shelldocs Shelldocs processes comments on Bash functions for annotations similar to Javadoc. It also includes built-in audience scoping functionality similar to the doclet from Audience Annotations.
  • Release Doc Maker Release Doc Maker analyzes Jira and Git information to produce Markdown formatted release notes.
  • yetus-maven-plugin Builds a maven plugin that provides some small utilities for some uncommon maven requirements (such as symlinks) in addition to being mavenized versions of some of the Apache Yetus functionality.

Building Quickstart

For full instructions on how to build releases and the website, see the guide to contributing for requirements and instructions.

# Launch a Docker container that has all of the project's dependencies and a working build environment
./start-build-env.sh

# Build the binary tarball, located in yetus-dist/target/artifacts:
mvn clean install

# Build the binary and source tarballs and sign the content:
mvn clean install -Papache-release

# Same, but if outside the container and need to let the system know that the OS uses 'gpg2' instead of 'gpg':
mvn clean install -Papache-release -Pgpg2

# Build the binary and source tarballs, but skip signing them:
mvn clean install -Papache-release -Dgpg.sign=skip

# Build the website (requires a mvn install first)
mvn site site:stage

After executing one or more of the Apache Maven commands, artifacts will be in yetus-dist/target/artifacts or ready for a mvn deploy.