satosa-docker

This is the source repository of the Docker "Official Image" for satosa.

The image description on Docker Hub is generated from the docker-library/docs repository, specifically the satosa directory.

See a change merged here that hasn't shown up on Docker Hub?

For more information about the Docker "Official Images" change lifecycle, see the "An image's source changed in Git, now what?" FAQ entry.

For outstanding satosa image PRs, check PRs with the "library/satosa" label on the official-images repository. For the current "source of truth" for the satosa image, see the library/satosa file in the official-images repository.

Build	Status	Badges	(per-arch)

Contributing

This project uses the Git feature branch workflow. Please submit your changes for review as a GitHub pull request.

In forks of this repository, enable the GitHub Actions workflows. GitHub Actions runs two workflows when developers push commits to a branch. Verify Templating checks for uncommitted changes. GitHub CI builds and tests the container images.

Development Environment

This project uses the following software:

• Docker 20.10 or newer

• GNU awk, GNU Find Utilities, GNU Wget, and jq, for the templating engine and version tracker

• GNU Make and Go, required by bashbrew and manifest-tool

• bashbrew, the Docker Official Images build tool

• manifest-tool, which generates the shared tag index

• (optional) qemu-user-static, to test containers on other hardware architecture via emulation

Before cloning the repository or working within it, set the file mode creation mask to 0022 or u=rwx,g=rx,o=rx.

Coding Style

Follow the Docker Official Images review guidelines and Dockerfile best practices.

In Dockerfiles and shell scripts, please use tabs for indentation instead of spaces.

Commit Messages

This project uses Conventional Commits 1.0.0. Valid commit types are:

• build—changes to the build system or external dependencies

• ci—changes to the CI configuration files and scripts

• docs—documentation-only changes

• feat—a new feature

• fix—a bug fix

• perf—a code change that improves performance

• refactor—a code change that neither fixes a bug nor adds a feature

• test—new tests or corrections to existing tests

No commit scopes are currently in use.

Update Process

In a fork of this repository:

1. Review the list of version aliases at the beginning of generate-stackbrew-library.sh.

2. Run update.sh, specifying the desired major and minor version of SATOSA. For example:

   ./update.sh 8.1

3. Remove outdated versions of SATOSA or base container images from versions.json, and delete the corresponding SATOSA container image definitions from the repository, e.g., the 8.0/ or 8.1/*alpine3.14*/ folders.

4. Mention the new SATOSA or base container version in the commit message subject, reference the release announcement in the commit message body. For example:

   feat: version bump to SATOSA v8.1.0
   
   Cf. https://github.com/IdentityPython/SATOSA/commit/d44b54433c5b817cf0409855881f6f2c80c27f5c

   Or for example:

   feat: version bump to Alpine Linux v3.16
   
   Cf. https://www.alpinelinux.org/posts/Alpine-3.16.0-released.html

5. Submit a pull request after both GitHub Actions workflows complete successfully.

After accepting a pull request, fork and edit the Docker Official Images library entry for SATOSA:

1. Replace its contents with the output of generate-stackbrew-library.sh.

2. Use a commit message referencing the release announcement. For example:

   Update SATOSA to v8.0.1
   
   Cf. https://github.com/IdentityPython/SATOSA/commit/1a408439a6b8855346e5ca2c645dee6ab1ce8c0a

   Or for example:

   Update SATOSA base container images to Alpine Linux v3.16
   
   Cf. https://www.alpinelinux.org/posts/Alpine-3.16.0-released.html

3. Submit a pull request when finished.