Apache Sling Aggregator
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
.sling-module.xml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
README.md
Sling-Repos.csv
add-badges.sh
collect-sling-repos.groovy
default.xml
generate-aggregator-table.sh

README.md

License

Apache Sling Aggregator

This module is part of the Apache Sling project.

It provides an XML file that lists all Sling modules, to allow for tools like repo to process multiple repositories at once.

The list of modules is in a self-explaining format and can also be used in your own scripts if preferred.

Note that there are related efforts at SLING-7331 and SLING-7262, we'll need to consolidate all this at some point.

Modules

You can find a list of the Apache Sling modules here. This list is generated from the script generate-aggregator-table.sh..

Updating Module Badges

We have a simple script to update the badges in GitHub's README.md files. To update all repositories:

./add-badges.sh [SLING_DIR]

To update a single repository:

./add-badges.sh [SLING_DIR] [REPO_NAME]

Updating the Aggregator List

To update the aggregator list:

./generate-aggregator-table.sh [SLING_DIR]

Dependencies

This script depends on the following utilities:

Prerequisites

  1. Use the repo tool to extract all of the repositories in the sling aggregator
  2. Ensure you have SSH based access enabled to GitHub
  3. Ensure all repository workspaces are in a clean state

Retrieving all Sling modules

This module allows quick checkout of all Sling modules from Git. It requires the local installation of the repo tool.

Repo Tool Installation (all platforms)

$ curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
$ chmod a+x ~/bin/repo

See also the detailed instructions at https://source.android.com/source/downloading#installing-repo.

Repo Tool Installation on Mac with 2Homebrew

brew install repo

Synchronizing all Git repositories

Initialise the local repo checkout and synchronise all git repositories. The commands below must be run in the sling-aggreator git checkout.

$ repo init --no-clone-bundle -u https://github.com/apache/sling-aggregator.git
$ repo sync --no-clone-bundle -j 16

The output is a flat list of all Sling modules.

The -j 16 flag instructs repo to run 16 parallel checkout jobs and is added for performance reasons only.

Updating the list of modules

That list is found in the default.xml file.

It is used to generate the list of Git Repositories on our website.

Install Groovy on Mac with Homebrew

brew install groovy

To update it:

groovy collect-sling-repos.groovy > default.xml

Check changes with git diff and commit if needed.