{"id":26959299,"url":"https://github.com/tmknom/dockerfiles","last_synced_at":"2025-04-03T04:37:26.055Z","repository":{"id":37183371,"uuid":"469712953","full_name":"tmknom/dockerfiles","owner":"tmknom","description":"A collection of Dockerfiles.","archived":false,"fork":false,"pushed_at":"2024-05-01T00:59:30.000Z","size":253,"stargazers_count":6,"open_issues_count":4,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-05-01T01:50:48.528Z","etag":null,"topics":["docker","dockerfile"],"latest_commit_sha":null,"homepage":"","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tmknom.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-03-14T11:57:40.000Z","updated_at":"2024-05-01T01:50:51.196Z","dependencies_parsed_at":"2024-02-05T03:37:54.886Z","dependency_job_id":null,"html_url":"https://github.com/tmknom/dockerfiles","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmknom%2Fdockerfiles","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmknom%2Fdockerfiles/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmknom%2Fdockerfiles/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmknom%2Fdockerfiles/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tmknom","download_url":"https://codeload.github.com/tmknom/dockerfiles/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246939174,"owners_count":20857916,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","dockerfile"],"created_at":"2025-04-03T04:37:25.421Z","updated_at":"2025-04-03T04:37:26.045Z","avatar_url":"https://github.com/tmknom.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dockerfiles\n\nA collection of Dockerfiles.\n\n## Description\n\nThis is a collection of dockerfiles that keep clean code.\n\nAvailable dockerfiles are supported the following tools:\n\n- **prettier**: It's an opinionated code formatter, see the [documents](https://prettier.io/docs/en/).\n- **yamllint**: It's a linter for YAML files, see the [documents](https://yamllint.readthedocs.io/en/stable/).\n- **markdownlint**: It's a style checker and lint tool for Markdown files, see the [documents](https://github.com/DavidAnson/markdownlint).\n- **jsonlint**: It's a JSON parser and validator, see the [documents](https://github.com/zaach/jsonlint).\n\nThese are useful tools, but there is no official image.\nTherefore, this repository creates and distributes these lightweight images.\n\n## Usage\n\n### Pull\n\nYou can pull from Docker Hub or GitHub Packages, whichever you prefer.\nUsing prettier as an example, pull as the following commands.\n\n**Docker Hub:**\n\n```shell\ndocker pull tmknom/prettier\n```\n\n**GitHub Packages:**\n\n```shell\ndocker pull ghcr.io/tmknom/dockerfiles/prettier\n```\n\nThe following shows how to use it when pulled from Docker Hub.\n\n### prettier\n\n```shell\ndocker run --rm -v \"$(pwd):/work\" tmknom/prettier --check --parser=markdown README.md\n```\n\nFor more information, see [prettier/README.md](/prettier/README.md).\n\n### yamllint\n\n```shell\ndocker run --rm -v \"$(pwd):/work\" tmknom/yamllint -- .\n```\n\nFor more information, see [yamllint/README.md](/yamllint/README.md).\n\n### markdownlint\n\n```shell\ndocker run --rm -v \"$(pwd):/work\" tmknom/markdownlint -- .\n```\n\nFor more information, see [markdownlint/README.md](/markdownlint/README.md).\n\n### jsonlint\n\n```shell\ndocker run --rm -v \"$(pwd):/work\" tmknom/jsonlint --compact --quiet foo.json\n```\n\nFor more information, see [jsonlint/README.md](/jsonlint/README.md).\n\n## Supported platforms\n\n- linux/amd64\n- linux/arm64\n\n## Developer Guide\n\n\u003c!-- markdownlint-disable no-inline-html --\u003e\n\u003cdetails\u003e\n\u003csummary\u003eClick to see details\u003c/summary\u003e\n\n### Requirements\n\n- [GNU Make](https://www.gnu.org/software/make/)\n- [Docker](https://docs.docker.com/get-docker/)\n- [GitHub CLI](https://cli.github.com/)\n\n### Development\n\n#### Creating a new Dockerfile\n\n1. Create `\u003cimage_name\u003e/` directory\n2. Define docker image: `Dockerfile`, `entrypoint.sh`, `.dockerignore`\n3. Manage package file: `package.json` or `requirements.txt`\n\n#### Testing for a new Docker Image\n\n1. Create `.github/tests/\u003cimage_name\u003e/` directory\n2. Write test script: `test.sh`\n3. Add test fixtures: `valid_\u003cextension\u003e.txt` and `invalid_\u003cextension\u003e.txt`\n\n#### Management for releasing and updating dependencies\n\n1. Create release action: `.github/workflows/release-\u003cimage_name\u003e.yml`\n2. Configure version updates for dependencies: `.github/dependabot.yml`\n\n#### Documentation for users\n\n1. Write details for the new docker image: `\u003cimage_name\u003e/README.md`\n2. Update description and append usage: `README.md`\n\n### Test\n\nRun the following command:\n\n```shell\nmake test\n```\n\nThen pull image from Docker Hub and GitHub Packages, and run test scripts.\n\n### CI\n\nWhen create a pull request, the following workflows are executed automatically at GitHub Actions.\n\n- [Lint Docker](/.github/workflows/lint-docker.yml)\n- [Lint YAML](/.github/workflows/lint-yaml.yml)\n- [Lint Markdown](/.github/workflows/lint-markdown.yml)\n- [Lint Shell](/.github/workflows/lint-shell.yml)\n- [Lint Action](/.github/workflows/lint-action.yml)\n\n### Release management\n\n1. Update Dockerfile or package management file\n2. Commit, push, and create a pull request\n3. After merged, run [Workflows](/.github/workflows) with `release-` prefix automatically at GitHub Actions\n\nThen, publishes Docker images to Docker Hub and GitHub Packages. :rocket:\n\n### Dependency management\n\nUse Dependabot version updates.\nFor more information, see [dependabot.yml](/.github/dependabot.yml).\n\n### Secrets management\n\nStored environment secrets for the following environments in this repository.\n\n#### release\n\nReference from releasing workflows such as `.github/workflows/release-prettier.yml`.\n\n- `DOCKERHUB_TOKEN`: Personal access token used to log against Docker Hub.\n\n### Versioning of the entire repository\n\n#### 1. Bump up to a new version\n\nRun the following command to bump up.\n\n```shell\nmake bump\n```\n\nThis command will execute the following steps:\n\n1. Update [VERSION](/VERSION)\n2. Commit, push, and create a pull request\n3. Open the web browser automatically for reviewing pull request\n\nThen review and merge, so the release is ready to go.\n\n#### 2. Publish the new version\n\nRun the following command to publish a new tag at GitHub.\n\n```shell\nmake release\n```\n\nFinally, we can use the new version! :tada:\n\n\u003c/details\u003e\n\u003c!-- markdownlint-enable no-inline-html --\u003e\n\n## Changelog\n\nSee [CHANGELOG.md](/CHANGELOG.md).\n\n## License\n\nApache 2 Licensed. See [LICENSE](/LICENSE) for full details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftmknom%2Fdockerfiles","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftmknom%2Fdockerfiles","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftmknom%2Fdockerfiles/lists"}