darthjee/scripts repository overview

darthjee/scripts

⁠Scripts

This repository contains several Docker images, each organized in its own folder and version. This documentation refers to the scripts image.

⁠About the image

The scripts image is a collection of auxiliary scripts, organized to facilitate both the building of other Docker images and development inside containers.

⁠Scripts structure

• builder/
  Scripts mainly used during the build process of other Docker images. Below is a list of available builder scripts:

  • bower_builder.sh: Installs Bower dependencies and manages Bower cache for reproducible builds.
  • bundle_builder.sh: Installs Ruby gems using Bundler and manages gem cache for efficient builds.
  • poetry_builder.sh: Installs Python dependencies using Poetry, handling cache and new package management for Python projects.
  • yarn_builder.sh: Installs Node.js dependencies using Yarn, managing both global and user-level cache for faster and reproducible builds.

• sbin/
  Scripts added to the final images for use during development. Below is a list of available sbin scripts:

  • build_gem.sh: Automates the process of building and releasing Ruby gems, ensuring version and tag consistency.
  • check_gems.sh: Checks for missing or outdated Ruby gems and can upgrade all gems as needed.
  • check_readme.sh: Verifies if the README contains a link to the correct RubyDoc documentation for the current gem version.
  • check_specs: Runs automated tests based on configuration, supporting custom test file discovery.
  • deploy_frontend.sh: Builds frontend assets and deploys them to a remote server using SSH and rsync.
  • docker_hub.sh: Handles Docker Hub authentication and allows pushing updated repository descriptions via the Docker Hub API.
  • rubycritic.sh: Runs RubyCritic on changed files to provide code quality reports for Ruby projects.

⁠How to use

This image is not intended for standalone use, but rather as a base or complement for other Docker images, providing ready-to-use tools and utilities.

You can use the scripts directly in your Dockerfiles or during development, as needed by your project.

⁠Usage example

FROM darthjee/scripts:latest as scripts
FROM <base_image> as base

# Base building

##### BUILD STEP #######

FROM base as builder
# build image

COPY --from=scripts /home/scripts/builder/bundle_builder.sh /usr/local/sbin/bundle_builder.sh
RUN /bin/bash bundle_builder.sh

##### FINAL STEP #######
FROM base as builder

COPY --chown=app:app --from=builder /home/app/bundle/ /usr/local/bundle/

COPY --from=scripts /home/scripts/sbin/check_spec /usr/local/sbin/


#Final building

⁠License

See the LICENSE file for more information.