Differences between revisions 1 and 2
Revision 1 as of 2019-02-08 22:53:36
Size: 3774
Comment: and distribution guidelines DRAFT
Revision 2 as of 2019-02-08 22:55:42
Size: 3800
Comment: fix bullet points
Deletions are marked like this. Additions are marked like this.
Line 6: Line 6:
- Source releases and connivence binaries need to be made from IPMC and PPMC approved ASF releases.
- An incubating disclaimer must be clearly be displayed where the artefacts are made available.
- 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 artefact in under the ALv2 license.
- Where possible these artefacts should not be referred to as releases.
 * Source releases and connivence binaries need to be made from IPMC and PPMC approved ASF releases.
 * An incubating disclaimer must be clearly be displayed where the artefacts are made available.
 * 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 artefact in under the ALv2 license.
 * Where possible these artefacts should not be referred to as releases.
Line 20: Line 20:
- Any releases need to include the text of the incubation disclaimer.
- The release page must not contain release candidates, nightly or snapshots releases.
- Any releases that exist before coming into incubation need to be clearly described and tagged as such on https://github.com/apache/incubator-<project>/tags.
- Release candidates, nightly or snapshots releases can be tagged and appear on https://github.com/apache/incubator-<project>/tags.
 * Any releases need to include the text of the incubation disclaimer.
 * The release page must not contain release candidates, nightly or snapshots releases.
 * Any releases that exist before coming into incubation need to be clearly described and tagged as such on https://github.com/apache/incubator-<project>/tags.
 * Release candidates, nightly or snapshots releases can be tagged and appear on https://github.com/apache/incubator-<project>/tags.
Line 30: Line 30:
- 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 artefact containing unapproved code.
- Release candidates, nightly or snapshots need to be clearly tagged.
- The latest tag should not point to an artefact containing unapproved code e.g. to master or dev branches or to a RC or snapshot.
 * 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 artefact containing unapproved code.
 * Release candidates, nightly or snapshots need to be clearly tagged.
 * The latest tag should not point to an artefact containing unapproved code e.g. to master or dev branches or to a RC or snapshot.
Line 42: Line 42:
- The readme tab needs to include the text of the incubation disclaimer.
- “npm install apache<project>” should not install an artefact containing unapproved code.
- The latest release should not point to an artefact containing unapproved code e.g. a release candidate or snapshot.
- Release candidates, nightly or snapshots need to be clearly tagged.
- The license field should display the ALv2 license.
 * The readme tab needs to include the text of the incubation disclaimer.
 * “npm install apache<project>” should not install an artefact containing unapproved code.
 * The latest release should not point to an artefact containing unapproved code e.g. a release candidate or snapshot.
 * Release candidates, nightly or snapshots need to be clearly tagged.
 * The license field should display the ALv2 license.
Line 53: Line 53:
- The project description should include the incubator disclaimer.
- “pip install apache<project>" should not install an artefact containing unapproved code.
- Release candidates, nightly or snapshots need to be clearly tagged as pre-release on https://pypi.org/project/apaceh<project>/#history
- The latest version should not point to an artefact containing unapproved code e.g. to a release candidate or snapshot
- The meta license field should display the ALv2 license.
 * The project description should include the incubator disclaimer.
 * “pip install apache<project>" should not install an artefact containing unapproved code.
 * Release candidates, nightly or snapshots need to be clearly tagged as pre-release on https://pypi.org/project/apaceh<project>/#history
 * The latest version should not point to an artefact containing unapproved code e.g. to a release candidate or snapshot
 * The meta license field should display the ALv2 license.

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 artefacts on other platforms as long as they follow these general guidelines:

  • Source releases and connivence binaries need to be made from IPMC and PPMC approved ASF releases.
  • An incubating disclaimer must be clearly be displayed where the artefacts are made available.
  • 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 artefact in under the ALv2 license.
  • Where possible these artefacts should not be referred to as releases.

If any podling is found not to comply they will be asked to fix it, if a fix doesn’t happen with a week they will be asked to remove the offending artefact(s), if a podling commits serial offences or fails to remove artefacts when asked to within a week they will be banned from using that distribution mechanism altogether. The IPMC reserves the right to ask INFRA to remove the artifact if the podling doesn't follow these guidelines.

GitHub

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

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

Docker

Artefacts 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 ensue 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 artefact containing unapproved code.

  • Release candidates, nightly or snapshots need to be clearly tagged.
  • The latest tag should not point to an artefact containing unapproved code e.g. to master or dev branches or to a RC or snapshot.

NPM

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

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

  • The readme tab needs to include the text of the incubation disclaimer.
  • “npm install apache<project>” should not install an artefact containing unapproved code.

  • The latest release should not point to an artefact containing unapproved code e.g. a release candidate or snapshot.
  • Release candidates, nightly or snapshots need to be clearly tagged.
  • The license field should display the ALv2 license.

PiPy

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

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

  • The project description should include the incubator disclaimer.
  • “pip install apache<project>" should not install an artefact containing unapproved code.

  • Release candidates, nightly or snapshots need to be clearly tagged as pre-release on https://pypi.org/project/apaceh<project>/#history

  • The latest version should not point to an artefact containing unapproved code e.g. to a release candidate or snapshot
  • The meta license field should display the ALv2 license.

DistributionGuidelines (last edited 2019-02-11 20:48:42 by Justin Mclean)