You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

For modules that are no longer recommended to use (because there is a replacement or they are just obsolete), the following procedure shall be used:

  1. Create a branch "maintenance" with the last version before deprecation
  2. Empty the master branch and only leave just a README.md file containing the line
    "For reference or potential bugfix releases use the 'maintenance' branch"
    (where "maintenance" is linked to the branch where the last "master" code is found)
  3. Tag the module as deprecated  using the .asf.yaml features for git repositories feature. If no such file is present make sure to use the default values from Using Git with Sling#Boilerplatefiles .

See the sling-org-apache-sling-starter-startup module as an example.

Deprecated Sling repositories can then be found with a GitHub query for the sling + deprecated topics.

This procedure replaces the old "attic" space in SVN, which is no longer an option since Sling has moved to Git.


Reasoning for the approach

  • the README file with the obsolete text is not overseen (with the
    long list of folders/files from src/main, CONTRIBUTING.md, to pom.xml the
    notice in the README would get easily overlooked)
  •  if necessary it's still possible to look at the code (easy enough with one click) or even release from it (maven-release-plugin does not worry too much about branch names)
  • No labels