sergiozsz/rsmetacheck repository overview

⁠rsmetacheck Docker Image

Docker image for **rsmetacheck **, providing a containerized and reproducible way to run the tool.

⁠Original project

rsmetacheck is developed and maintained by SoftwareUnderstanding and its contributors.

Original repository:

https://github.com/SoftwareUnderstanding/rsmetacheck⁠

All credit for the development of rsmetacheck belongs to the original authors and contributors.

⁠Dockerization

The Docker packaging and configuration for this image were created by Sergio Zaballos.

This Docker image packages the original rsmetacheck software and is intended to make its deployment and execution easier. It does not represent a separate implementation of rsmetacheck .

⁠SoMEF configuration

rsmetacheck uses SoMEF (Software Metadata Extraction Framework) to extract metadata from the repositories being analyzed.

SoMEF can work without authentication credentials, but API rate limits will be significantly lower. For batch processing or the analysis of many repositories, configuring the corresponding repository hosting service credentials is recommended.

There are two ways to provide the SoMEF configuration when using this Docker image.

⁠Option 1 — Provide the configuration at runtime using an .env file (recommended)

The recommended approach is to keep credentials outside the Docker image and provide them when the container is started.

Create an .env file containing the environment variables required by your SoMEF configuration.

For example:

# SoMEF / repository service credentials
GITHUB_API_TOKEN=your_github_token
GITLAB_API_TOKEN=your_gitlab_token

Then provide the file to Docker using:

docker run --rm \
  --env-file .env \
  -v ${PWD}:/workspace \
  sergiozsz/rsmetacheck:<version> \
  rsmetacheck \
  --input https://github.com/SoftwareUnderstanding/rsmetacheck \
  --somef-output /workspace/somef_outputs \
  --pitfalls-output /workspace/pitfalls_outputs \
  --analysis-output /workspace/analysis_results.json

Using an .env file allows the same Docker image to be used with different credentials and configurations without rebuilding it.

It also prevents authentication tokens from being stored directly inside the Docker image.

⁠SoMEF configuration without credentials

SoMEF may also be used without authentication tokens.

The container entrypoint creates a SoMEF configuration when the container starts. If no credentials are provided, SoMEF is configured without authentication tokens.

Users processing a large number of repositories should provide their own credentials using the runtime configuration described above.

For more information about SoMEF configuration, see the original SoMEF project:

https://github.com/KnowledgeCaptureAndDiscovery/somef⁠

⁠Usage

Pull a specific version:

docker pull sergiozsz/rsmetacheck:<version>

Example:

docker pull sergiozsz/rsmetacheck:0.3.6

Run rsmetacheck :

docker run --rm \
  --env-file .env \
  -v $PWD:/workspace \
  sergiozsz/rsmetacheck:0.3.6 \
  rsmetacheck \
  --input https://github.com/SoftwareUnderstanding/rsmetacheck \
  --somef-output /workspace/somef_outputs \
  --pitfalls-output /workspace/pitfalls_outputs \
  --analysis-output /workspace/analysis_results.json

⁠Maintenance

rsmetacheck itself is maintained by the SoftwareUnderstanding project.

This Docker image may be updated when new versions of rsmetacheck are released or when changes to the Docker configuration are required.

For issues related to rsmetacheck itself, please use the original repository:

https://github.com/SoftwareUnderstanding/rsmetacheck⁠

⁠License

rsmetacheck and the software included in this image remain subject to the license of the original project.

For the authoritative license information, see:

https://github.com/SoftwareUnderstanding/rsmetacheck⁠

⁠Acknowledgements

This Docker image is based on the original **rsmetacheck ** software developed by the SoftwareUnderstanding organization.

Special thanks and credit go to Anas El Hounsri and the rsmetacheck contributors for the development of the original tool.

This image only provides a containerized distribution of rsmetacheck . The original software, its design, implementation, and scientific/technical contributions belong to the upstream project and its authors.

⁠References

• rsmetacheck original repository: https://github.com/SoftwareUnderstanding/rsmetacheck⁠
• SoftwareUnderstanding GitHub organization: https://github.com/SoftwareUnderstanding⁠