This Confluence has been LDAP enabled, if you are an ASF Committer, please use your LDAP Credentials to login. Any problems file an INFRA jira ticket please.

Page tree
Skip to end of metadata
Go to start of metadata

Guidelines to help you comply with the ASF release and distribution policies

DRAFT DRAFT DRAFT DRAFT

In addition to the Apache mirror system incubating projects may distribute artifacts on other platforms as long as they follow these general guidelines:

  • Source releases and convenience binaries need to be made from IPMC and PPMC approved ASF releases.
  • Release candidates, nightlys and snapshots must not be advertised to the general public.
  • Apache project branding and naming needs to be respected.
  • It should be clear that the artifacts are under the ALv2 license.
  • An incubating disclaimer must be clearly displayed where the artifacts are made available.
  • All PPMC members must have access to administer the platform and the credentials recorded where any PPMC member can access them.
  • Where possible these artifacts should not be referred to as releases.

These SHOULD be followed. The podling can ask the IPMC for permission to do otherwise.

Motivation

The ASF is responsible for providing software which can be used in accordance with our license. Code or artifacts built from code without clean IP can mean that code that doesn't belong to us slips into users projects. This would expose our users and the ASF to the risk of lawsuit. One purpose of the incubating process and its release process is to ensure that our users can trust our projects. Releasing artifacts built from code that hasn't been approved by the IPMC circumvents this process. It robs the PPMC of learning opportunities. It increases the likelihood that we might accidentally betray the trust of our users.

At the same time binary artifacts on automated distribution platforms are important to our users for a wide variety of reasons. This policy is intended to balance these priorities. If you believe you have a case in which this policy is inadequate to your situation please bring this to our attention by mailing either general@incubator.apache.org or private@incubator.apache.org

GitHub

Artifacts show up on https://github.com/apache/incubator-<project>/releases

To comply with ASF release and distributions please ensure the following:

  • Any releases need to include the text of the incubation disclaimer.
  • The release page must not contain release candidates, nightly or snapshots releases that have not been tagged as prereleases. (Ignoring that GitHub also displays tags on the release page.)
  • Any releases that exist before coming into incubation need to be clearly described on the release page and tagged as such on https://github.com/apache/incubator-<project>/tags.
  • Release candidates, nightlys or snapshots releases can be tagged and appear on https://github.com/apache/incubator-<project>/tags.

Docker

Artifacts need to be placed in https://hub.docker.com/r/apache/<project> or https://hub.docker.com/u/apache<project>/<project>

To comply with ASF release and distributions please ensure the following:

  • The overview should include the incubator disclaimer.
  • The docker file (if it exists) should include an ASF header.
  • The docker file (if it exists) should include the incubator disclaimer.
  • docker pull apache/<project> should not install an artifact containing unapproved code.
  • Release candidates, nightlys or snapshots need to be clearly tagged.
  • The latest tag should not point to an artifact containing unapproved code e.g. to master or dev branches or to a RC or snapshot.

NPM

Artifacts show up on https://www.npmjs.com/package/apache<project> version page

To comply with ASF release and distributions please ensure the following:

  • The readme tab needs to include the text of the incubation disclaimer.
  • npm install apache<project> should not install an artifact containing unapproved code.
  • The latest release should not point to an artifact containing unapproved code e.g. a release candidate or snapshot.
  • Release candidates, nightlys or snapshots need to be clearly tagged.
  • The license field should display the ALv2 license.

PiPy

Artifacts need to be placed in https://pypi.org/project/apache<project>/

To comply with ASF release and distributions please ensure the following:

  • The project description should include the incubator disclaimer.
  • pip install apache<project> should not install an artifact containing unapproved code.
  • Release candidates, nightlys or snapshots need to be clearly tagged as pre-release on https://pypi.org/project/apache<project>/#history
  • The latest version should not point to an artifact containing unapproved code e.g. to a release candidate or snapshot
  • The meta license field should display the ALv2 license.
  • No labels

2 Comments

  1. Naming artifacts 'apache-<project>' may generally be more readable and pleasant. Is the 'apache<project>' convention open for debate?

  2. <apache>-project would be fine, the intent is still clear.