
GITHUB . COM {
}
Detected CMS Systems:
- Wordpress (2 occurrences)
Title:
Update GitHub Action step "Check docker image" to accommodate for usernames with upper case characters Β· Issue #5503 Β· squidfunk/mkdocs-material
Description:
Context We intend to keep our fork in sync, and automatically publish updated container images to our GHCR. Description Our organization username has upper case characters in it, and this causes the "Check docker image" build step to fai...
Website Age:
17 years and 8 months (reg. 2007-10-09).
Matching Content Categories {π}
- Transportation
- Mobile Technology & AI
- Games
Content Management System {π}
What CMS is github.com built with?
Github.com utilizes WORDPRESS.
Traffic Estimate {π}
What is the average monthly size of github.com audience?
ππ Tremendous Traffic: 10M - 20M visitors per month
Based on our best estimate, this website will receive around 10,634,219 visitors per month in the current month.
check SE Ranking
check Ahrefs
check Similarweb
check Ubersuggest
check Semrush
How Does Github.com Make Money? {πΈ}
Subscription Packages {π³}
We've located a dedicated page on github.com that might include details about subscription plans or recurring payments. We identified it based on the word pricing in one of its internal links. Below, you'll find additional estimates for its monthly recurring revenues.How Much Does Github.com Make? {π°}
Subscription Packages {π³}
Prices on github.com are in US Dollars ($).
They range from $4.00/month to $21.00/month.
We estimate that the site has approximately 5,306,347 paying customers.
The estimated monthly recurring revenue (MRR) is $22,286,656.
The estimated annual recurring revenues (ARR) are $267,439,867.
Wordpress Themes and Plugins {π¨}
What WordPress theme does this site use?
It is strange but we were not able to detect any theme on the page.
What WordPress plugins does this website use?
It is strange but we were not able to detect any plugins on the page.
Keywords {π}
docker, case, issue, image, run, github, upper, bug, squidfunk, check, change, step, characters, sign, user, githubeventrepositoryfullname, resolved, open, actions, projects, update, action, joshooaj, updated, build, uid, ghtokenghtoken, pwddocs, request, related, repofullname, idea, navigation, fork, code, issues, pull, requests, discussions, security, accommodate, usernames, closed, description, publish, container, images, ghcr, organization, error,
Topics {βοΈ}
io/milestonesystemsinc/mkdocs-material-insiders squidfunk/mkdocs-material-insiders creating-a-reproduction guide squidfunk/mkdocs-material github action workflow activity joshooaj added related issues open projects upper case characters github actions exit code 125 included relevant links bug resolved issue bug template requires check docker image invalid reference format ci/cd experience comment metadata assignees calling docker run projects milestone build step change request guidelines discussions issue related change parameter expansion update process completed 'docker run docker image docker run /docs ghcr lower case bug report attached reproduction step parameter expansion io/${repo_full_name unaltered build change request proposed change gh_token=${gh_token} makes sense impact authors entire community sounds legit milestone relationships fork description organization username syntax ${var
Payment Methods {π}
- Braintree
Questions {β}
- Already have an account?
Schema {πΊοΈ}
DiscussionForumPosting:
context:https://schema.org
headline:Update GitHub Action step "Check docker image" to accommodate for usernames with upper case characters
articleBody:### Context
We intend to keep our fork in sync, and automatically publish updated container images to our GHCR.
### Description
Our organization username has upper case characters in it, and this causes the "Check docker image" build step to fail with the following error:
```
Run docker run --rm -i --user $(id -u):$(id -g) -e GH_TOKEN=${GH_TOKEN} -v ${PWD}:/docs ghcr.io/MilestoneSystemsInc/mkdocs-material-insiders:9.1.11-insiders-4.33.1 new .
docker: invalid reference format: repository name must be lowercase.
See 'docker run --help'.
Error: Process completed with exit code 125.
```
To resolve this for any user or organization with upper case characters in their GitHub name, I'm proposing to convert the value of `github.event.repository.full_name` to lower case before calling `docker run` when validating the docker image.
_Note: This is being shared as a change request instead of a bug because the bug template requires an attached reproduction. I don't think it makes sense to follow the [creating-a-reproduction guide](https://squidfunk.github.io/mkdocs-material/guides/creating-a-reproduction/) for an issue related to GitHub Action workflow(s)._
## Proposed change
In the example below, the "Check Docker image" step has the following modifications:
1. The value of `github.event.repository.full_name` is stored in an environment variable named `REPO_FULL_NAME`.
2. The executions of `docker run` are updated to use `${REPO_FULL_NAME,,}` in the image name instead of the raw value of `github.event.repository.full_name`.
_Note: The syntax `${VAR,,}` is an example of [parameter expansion](https://www.gnu.org/software/bash/manual/html_node/Shell-Parameter-Expansion.html) in bash. In this case it converts all upper case characters to lowercase. The reverse could be done with `${VAR^^}`._
```yaml
- name: Check Docker image
working-directory: /tmp
env:
REPO_FULL_NAME: '${{ github.event.repository.full_name }}'
run: |
docker run --rm -i --user $(id -u):$(id -g) -e GH_TOKEN=${GH_TOKEN} -v ${PWD}:/docs ghcr.io/${REPO_FULL_NAME,,}:${{ steps.meta.outputs.version }} new .
docker run --rm -i --user $(id -u):$(id -g) -e GH_TOKEN=${GH_TOKEN} -v ${PWD}:/docs ghcr.io/${REPO_FULL_NAME,,}:${{ steps.meta.outputs.version }} build
```
### Related links
- [Requesting a change](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/)
- [Parameter expansion](https://www.gnu.org/software/bash/manual/html_node/Shell-Parameter-Expansion.html)
### Use Cases
This change should not impact authors, users. It should only improve the CI/CD experience for anyone using GitHub Actions to publish updated container images to GHCR using the unaltered `build.yml` from `squidfunk/mkdocs-material` or `squidfunk/mkdocs-material-insiders`.
### Visuals
_No response_
### Before submitting
- [X] I have read and followed the [change request guidelines](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/).
- [X] I have verified that [my idea is a change request and not a bug report](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#its-not-a-bug-its-a-feature).
- [X] I have ensured that, to the best of my knowledge, [my idea will benefit the entire community](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#benefit-for-the-community).
- [X] I have included relevant links to [the documentation](https://squidfunk.github.io/mkdocs-material), related [issues](https://github.com/squidfunk/mkdocs-material/issues), and [discussions](https://github.com/squidfunk/mkdocs-material/discussions) to underline the need for my idea.
author:
url:https://github.com/joshooaj
type:Person
name:joshooaj
datePublished:2023-05-10T23:24:45.000Z
interactionStatistic:
type:InteractionCounter
interactionType:https://schema.org/CommentAction
userInteractionCount:1
url:https://github.com/5503/mkdocs-material/issues/5503
context:https://schema.org
headline:Update GitHub Action step "Check docker image" to accommodate for usernames with upper case characters
articleBody:### Context
We intend to keep our fork in sync, and automatically publish updated container images to our GHCR.
### Description
Our organization username has upper case characters in it, and this causes the "Check docker image" build step to fail with the following error:
```
Run docker run --rm -i --user $(id -u):$(id -g) -e GH_TOKEN=${GH_TOKEN} -v ${PWD}:/docs ghcr.io/MilestoneSystemsInc/mkdocs-material-insiders:9.1.11-insiders-4.33.1 new .
docker: invalid reference format: repository name must be lowercase.
See 'docker run --help'.
Error: Process completed with exit code 125.
```
To resolve this for any user or organization with upper case characters in their GitHub name, I'm proposing to convert the value of `github.event.repository.full_name` to lower case before calling `docker run` when validating the docker image.
_Note: This is being shared as a change request instead of a bug because the bug template requires an attached reproduction. I don't think it makes sense to follow the [creating-a-reproduction guide](https://squidfunk.github.io/mkdocs-material/guides/creating-a-reproduction/) for an issue related to GitHub Action workflow(s)._
## Proposed change
In the example below, the "Check Docker image" step has the following modifications:
1. The value of `github.event.repository.full_name` is stored in an environment variable named `REPO_FULL_NAME`.
2. The executions of `docker run` are updated to use `${REPO_FULL_NAME,,}` in the image name instead of the raw value of `github.event.repository.full_name`.
_Note: The syntax `${VAR,,}` is an example of [parameter expansion](https://www.gnu.org/software/bash/manual/html_node/Shell-Parameter-Expansion.html) in bash. In this case it converts all upper case characters to lowercase. The reverse could be done with `${VAR^^}`._
```yaml
- name: Check Docker image
working-directory: /tmp
env:
REPO_FULL_NAME: '${{ github.event.repository.full_name }}'
run: |
docker run --rm -i --user $(id -u):$(id -g) -e GH_TOKEN=${GH_TOKEN} -v ${PWD}:/docs ghcr.io/${REPO_FULL_NAME,,}:${{ steps.meta.outputs.version }} new .
docker run --rm -i --user $(id -u):$(id -g) -e GH_TOKEN=${GH_TOKEN} -v ${PWD}:/docs ghcr.io/${REPO_FULL_NAME,,}:${{ steps.meta.outputs.version }} build
```
### Related links
- [Requesting a change](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/)
- [Parameter expansion](https://www.gnu.org/software/bash/manual/html_node/Shell-Parameter-Expansion.html)
### Use Cases
This change should not impact authors, users. It should only improve the CI/CD experience for anyone using GitHub Actions to publish updated container images to GHCR using the unaltered `build.yml` from `squidfunk/mkdocs-material` or `squidfunk/mkdocs-material-insiders`.
### Visuals
_No response_
### Before submitting
- [X] I have read and followed the [change request guidelines](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/).
- [X] I have verified that [my idea is a change request and not a bug report](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#its-not-a-bug-its-a-feature).
- [X] I have ensured that, to the best of my knowledge, [my idea will benefit the entire community](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#benefit-for-the-community).
- [X] I have included relevant links to [the documentation](https://squidfunk.github.io/mkdocs-material), related [issues](https://github.com/squidfunk/mkdocs-material/issues), and [discussions](https://github.com/squidfunk/mkdocs-material/discussions) to underline the need for my idea.
author:
url:https://github.com/joshooaj
type:Person
name:joshooaj
datePublished:2023-05-10T23:24:45.000Z
interactionStatistic:
type:InteractionCounter
interactionType:https://schema.org/CommentAction
userInteractionCount:1
url:https://github.com/5503/mkdocs-material/issues/5503
Person:
url:https://github.com/joshooaj
name:joshooaj
url:https://github.com/joshooaj
name:joshooaj
InteractionCounter:
interactionType:https://schema.org/CommentAction
userInteractionCount:1
interactionType:https://schema.org/CommentAction
userInteractionCount:1
External Links {π}(8)
- What's the total monthly financial gain of https://github.blog?
- Income figures for https://squidfunk.github.io/mkdocs-material/guides/creating-a-reproduction/
- Learn about the earnings of https://www.gnu.org/software/bash/manual/html_node/Shell-Parameter-Expansion.html
- Check the income stats for https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/
- Check the income stats for https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#its-not-a-bug-its-a-feature
- Revenue of https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#benefit-for-the-community
- Income figures for https://squidfunk.github.io/mkdocs-material
- What's https://www.githubstatus.com/'s gross income?
Analytics and Tracking {π}
- Site Verification - Google
Libraries {π}
- Clipboard.js
- D3.js
- Lodash
Emails and Hosting {βοΈ}
Mail Servers:
- aspmx.l.google.com
- alt1.aspmx.l.google.com
- alt2.aspmx.l.google.com
- alt3.aspmx.l.google.com
- alt4.aspmx.l.google.com
Name Servers:
- dns1.p08.nsone.net
- dns2.p08.nsone.net
- dns3.p08.nsone.net
- dns4.p08.nsone.net
- ns-1283.awsdns-32.org
- ns-1707.awsdns-21.co.uk
- ns-421.awsdns-52.com
- ns-520.awsdns-01.net