Skip to content

Commit 5927bc5

Browse files
xenophonfxenophonf
committed
style: wrap long lines
1 parent f81c3d9 commit 5927bc5

File tree

1 file changed

+88
-52
lines changed

1 file changed

+88
-52
lines changed

‎README.md

Lines changed: 88 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,30 @@
11
# satosa-docker
22

3-
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/).
3+
This is the source repository of the
4+
[Docker "Official Image"](https://github.com/docker-library/official-images#what-are-official-images)
5+
for [`satosa`](https://hub.docker.com/_/satosa/).
6+
7+
The image description on Docker Hub is generated from
8+
[the docker-library/docs repository](https://github.com/docker-library/docs),
9+
specifically
10+
[the `satosa` directory](https://github.com/docker-library/docs/tree/master/satosa).
411

5-
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).
612

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

9-
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).
15+
For more information about the Docker "Official Images" change
16+
lifecycle, see
17+
[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).
18+
19+
For outstanding `satosa` image PRs, check
20+
[PRs with the "library/satosa" label on the official-images repository](https://github.com/docker-library/official-images/labels/library%2Fsatosa).
21+
For the current "source of truth" for the `satosa` image, see
22+
[the `library/satosa` file in the official-images repository](https://github.com/docker-library/official-images/blob/master/library/satosa).
1023

11-
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).
1224

1325
---
1426

15-
- [![build status badge](https://img.shields.io/github/workflow/status/IdentityPython/satosa-docker/GitHub%20CI/main?label=GitHub%20CI)](https://github.com/IdentityPython/satosa-docker/actions?query=workflow%3A%22GitHub+CI%22+branch%3Amain)
27+
- [![build status badge](https://img.shields.io/github/workflow/status/IdentityPython/satosa-docker/GitHub%20CI/main?label=GitHub%20CI)](https://github.com/IdentityPython/satosa-docker/actions?query=workflow%3A%22GitHub+CI%22+branch%3Amain)
1628

1729
| Build | Status | Badges | (per-arch) |
1830
|:-:|:-:|:-:|:-:|
@@ -22,39 +34,67 @@ For outstanding `satosa` image PRs, check [PRs with the "library/satosa" label o
2234

2335
---
2436

37+
2538
# Contributing
2639

27-
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).
40+
This project uses the
41+
[Git feature branch workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow).
42+
Please submit your changes for review as a
43+
[GitHub pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests).
44+
45+
In forks of this repository, enable the GitHub Actions workflows.
46+
GitHub Actions runs two workflows when developers push commits to a
47+
branch. [Verify Templating](actions/workflows/verify-templating.yml)
48+
checks for uncommitted changes. [GitHub CI](actions/workflows/ci.yml)
49+
builds and tests the container images.
2850

29-
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.
3051

3152
## Development Environment
3253

3354
This project uses the following software:
3455

3556
- [Docker 20.10 or newer](https://docs.docker.com/engine/install/)
3657

37-
- [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
58+
- [GNU awk](https://www.gnu.org/software/gawk/),
59+
[GNU Find Utilities](https://www.gnu.org/software/findutils/),
60+
[GNU Wget](https://www.gnu.org/software/wget/), and
61+
[jq](https://stedolan.github.io/jq/) for the templating engine and
62+
version tracker
3863

39-
- [GNU Make](https://www.gnu.org/software/make/) and [Go](https://go.dev/), required by bashbrew and manifest-tool
64+
- [GNU Make](https://www.gnu.org/software/make/) and
65+
[Go](https://go.dev/), required by bashbrew and manifest-tool
4066

41-
- [bashbrew](https://github.com/docker-library/bashbrew), the Docker Official Images build tool
67+
- [bashbrew](https://github.com/docker-library/bashbrew), the Docker
68+
Official Images build tool
4269

43-
- [manifest-tool](https://github.com/estesp/manifest-tool), which generates the shared tag index
70+
- [manifest-tool](https://github.com/estesp/manifest-tool), which
71+
generates the shared tag index
4472

45-
- (optional) [qemu-user-static](https://github.com/multiarch/qemu-user-static), to test containers on other hardware architecture via emulation
73+
- (optional; Linux-amd64 build hosts only)
74+
[qemu-user-static](https://github.com/multiarch/qemu-user-static)
75+
to test containers on other hardware architecture via emulation
76+
77+
Before cloning the repository or working within it, set the
78+
[file mode creation mask](https://en.wikipedia.org/wiki/Umask) to
79+
`0022` or `u=rwx,g=rx,o=rx`.
4680

47-
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`.
4881

4982
## Coding Style
5083

51-
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/).
84+
Follow
85+
[the Docker Official Images review guidelines](https://github.com/docker-library/official-images#review-guidelines)
86+
and
87+
[Dockerfile best practices](https://docs.docker.com/develop/develop-images/dockerfile_best-practices/).
88+
89+
In Dockerfiles and shell scripts, please use tabs for indentation
90+
instead of spaces.
5291

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

5593
## Commit Messages
5694

57-
This project uses [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Valid commit types are:
95+
This project uses
96+
[Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/).
97+
Valid commit types are:
5898

5999
- **build**—changes to the build system or external dependencies
60100

@@ -74,56 +114,52 @@ This project uses [Conventional Commits 1.0.0](https://www.conventionalcommits.o
74114

75115
No commit scopes are currently in use.
76116

117+
77118
## Update Process
78119

79120
In a fork of this repository:
80121

81-
1. Review the list of version aliases at the beginning of `generate-stackbrew-library.sh`.
82-
83-
2. Run [update.sh](update.sh), specifying the desired major and minor version of SATOSA. For example:
84-
85-
```bash
86-
./update.sh 8.1
87-
```
88-
89-
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.
90-
91-
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:
92-
93-
```
94-
feat: version bump to SATOSA v8.1.0
95-
96-
Cf. https://github.com/IdentityPython/SATOSA/commit/d44b54433c5b817cf0409855881f6f2c80c27f5c
97-
```
122+
1. Review the list of version aliases at the beginning of
123+
`generate-stackbrew-library.sh`.
98124

99-
Or for example:
125+
2. Run [update.sh](update.sh), specifying the desired major and minor
126+
version of SATOSA. For example:
100127

101-
```
102-
feat: version bump to Alpine Linux v3.16
128+
```bash
129+
./update.sh 8.1
130+
```
103131

104-
Cf. https://www.alpinelinux.org/posts/Alpine-3.16.0-released.html
105-
```
132+
3. Remove outdated versions of SATOSA or base container images from
133+
`versions.json`, and delete the corresponding SATOSA container
134+
image definitions from the repository, e.g., the `8.0/` or
135+
`8.1/*alpine3.14*/` folders.
106136

107-
5. Submit a pull request after both GitHub Actions workflows complete successfully.
137+
4. Mention the new SATOSA or base container version in the commit
138+
message subject, and reference the release announcement in the
139+
commit message body. For example:
108140

109-
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):
141+
```
142+
feat: version bump to SATOSA v8.1.0
110143
111-
1. Replace its contents with the output of [generate-stackbrew-library.sh](generate-stackbrew-library.sh).
144+
Cf. https://github.com/IdentityPython/SATOSA/commit/d44b54433c5b817cf0409855881f6f2c80c27f5c
145+
```
112146

113-
2. Use a commit message referencing the release announcement. For example:
147+
5. Submit a pull request after both GitHub Actions workflows complete
148+
successfully.
114149

115-
```
116-
Update SATOSA to v8.0.1
150+
6. After accepting a pull request, fork and edit
151+
[the Docker Official Images library entry for SATOSA](https://github.com/docker-library/official-images/edit/master/library/satosa).
117152

118-
Cf. https://github.com/IdentityPython/SATOSA/commit/1a408439a6b8855346e5ca2c645dee6ab1ce8c0a
119-
```
153+
7. Replace the library entry's contents with the output of
154+
[generate-stackbrew-library.sh](generate-stackbrew-library.sh).
120155

121-
Or for example:
156+
8. Again, use a commit message referencing the release announcement.
157+
For example:
122158

123-
```
124-
Update SATOSA base container images to Alpine Linux v3.16
159+
```
160+
feat: version bump to Alpine Linux v3.16
125161
126-
Cf. https://www.alpinelinux.org/posts/Alpine-3.16.0-released.html
127-
```
162+
Cf. https://www.alpinelinux.org/posts/Alpine-3.16.0-released.html
163+
```
128164

129-
3. Submit a pull request when finished.
165+
9. Submit a pull request when finished.

0 commit comments

Comments
 (0)