https://github.com/identitypython/satosa-docker
Docker Official Image packaging for SATOSA
https://github.com/identitypython/satosa-docker
Last synced: 3 months ago
JSON representation
Docker Official Image packaging for SATOSA
- Host: GitHub
- URL: https://github.com/identitypython/satosa-docker
- Owner: IdentityPython
- License: other
- Created: 2022-05-18T13:14:16.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-22T15:39:34.000Z (over 1 year ago)
- Last Synced: 2025-03-24T04:01:43.265Z (3 months ago)
- Language: Shell
- Size: 104 KB
- Stars: 9
- Watchers: 9
- Forks: 6
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# satosa-docker
This is the source repository of the [Docker "Official Image"](https://github.com/docker-library/official-images#what-are-official-images) for [`satosa`](https://hub.docker.com/_/satosa/).
The image description on Docker Hub is generated from [the docker-library/docs repository](https://github.com/docker-library/docs), specifically [the `satosa` directory](https://github.com/docker-library/docs/tree/master/satosa).
## 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](https://github.com/docker-library/faq#an-images-source-changed-in-git-now-what).
For outstanding `satosa` image PRs, check [PRs with the "library/satosa" label on the official-images repository](https://github.com/docker-library/official-images/labels/library%2Fsatosa). For the current "source of truth" for the `satosa` image, see [the `library/satosa` file in the official-images repository](https://github.com/docker-library/official-images/blob/master/library/satosa).
---
- [](https://github.com/IdentityPython/satosa-docker/actions?query=workflow%3A%22GitHub+CI%22+branch%3Amain)
| Build | Status | Badges | (per-arch) |
|:-:|:-:|:-:|:-:|
| [](https://doi-janky.infosiftr.net/job/multiarch/job/amd64/job/satosa/) | [](https://doi-janky.infosiftr.net/job/multiarch/job/arm32v5/job/satosa/) | [](https://doi-janky.infosiftr.net/job/multiarch/job/arm32v6/job/satosa/) | [](https://doi-janky.infosiftr.net/job/multiarch/job/arm32v7/job/satosa/) |
| [](https://doi-janky.infosiftr.net/job/multiarch/job/arm64v8/job/satosa/) | [](https://doi-janky.infosiftr.net/job/multiarch/job/i386/job/satosa/) | [](https://doi-janky.infosiftr.net/job/multiarch/job/mips64le/job/satosa/) | [](https://doi-janky.infosiftr.net/job/multiarch/job/ppc64le/job/satosa/) |
| [](https://doi-janky.infosiftr.net/job/multiarch/job/s390x/job/satosa/) | [](https://doi-janky.infosiftr.net/job/put-shared/job/light/job/satosa/) |
---
# Contributing
This project uses the [Git feature branch workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow). Please submit your changes for review as a [GitHub pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests).
In forks of this repository, enable the GitHub Actions workflows. GitHub Actions runs two workflows when developers push commits to a branch. [Verify Templating](actions/workflows/verify-templating.yml) checks for uncommitted changes. [GitHub CI](actions/workflows/ci.yml) builds and tests the container images.
## Development Environment
This project uses the following software:
- [Docker 20.10 or newer](https://docs.docker.com/engine/install/)
- [GNU awk](https://www.gnu.org/software/gawk/), [GNU Find Utilities](https://www.gnu.org/software/findutils/), [GNU Wget](https://www.gnu.org/software/wget/), and [jq](https://stedolan.github.io/jq/), for the templating engine and version tracker
- [GNU Make](https://www.gnu.org/software/make/) and [Go](https://go.dev/), required by bashbrew and manifest-tool
- [bashbrew](https://github.com/docker-library/bashbrew), the Docker Official Images build tool
- [manifest-tool](https://github.com/estesp/manifest-tool), which generates the shared tag index
- (optional) [qemu-user-static](https://github.com/multiarch/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](https://en.wikipedia.org/wiki/Umask) to `0022` or `u=rwx,g=rx,o=rx`.
## Coding Style
Follow [the Docker Official Images review guidelines](https://github.com/docker-library/official-images#review-guidelines) and [Dockerfile best practices](https://docs.docker.com/develop/develop-images/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](https://www.conventionalcommits.org/en/v1.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](update.sh), specifying the desired major and minor version of SATOSA. For example:
```bash
./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](https://github.com/docker-library/official-images/edit/master/library/satosa):
1. Replace its contents with the output of [generate-stackbrew-library.sh](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.