From 5bf030df68ce0ad95698add0fb5d2e79d4cb9f32 Mon Sep 17 00:00:00 2001 From: CrazyMax Date: Wed, 13 Sep 2023 09:15:19 +0200 Subject: [PATCH 1/4] chore: migrate to docker org --- .github/CODEOWNERS | 1 - .github/CONTRIBUTING.md | 4 ++-- .github/SUPPORT.md | 6 +++--- README.md | 22 +++++++++------------- action.yml | 6 +++--- package.json | 4 ++-- 6 files changed, 19 insertions(+), 24 deletions(-) delete mode 100644 .github/CODEOWNERS diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS deleted file mode 100644 index f7b8e1d..0000000 --- a/.github/CODEOWNERS +++ /dev/null @@ -1 +0,0 @@ -* @crazy-max diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index aeb9348..f01b13f 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -7,13 +7,13 @@ to the public under the [project's open source license](LICENSE). ## Submitting a pull request -1. [Fork](https://github.com/crazy-max/ghaction-setup-docker/fork) and clone the repository +1. [Fork](https://github.com/docker/setup-docker-action/fork) and clone the repository 2. Configure and install the dependencies: `yarn install` 3. Create a new branch: `git checkout -b my-branch-name` 4. Make your changes 5. Format code and build javascript artifacts: `docker buildx bake pre-checkin` 6. Validate all code has correctly formatted and built: `docker buildx bake validate` -7. Push to your fork and [submit a pull request](https://github.com/crazy-max/ghaction-setup-docker/compare) +7. Push to your fork and [submit a pull request](https://github.com/docker/setup-docker-action/compare) 8. Pat your self on the back and wait for your pull request to be reviewed and merged. Here are a few things you can do that will increase the likelihood of your pull request being accepted: diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md index de3944d..3742f3b 100644 --- a/.github/SUPPORT.md +++ b/.github/SUPPORT.md @@ -1,10 +1,10 @@ -# Support [![](https://isitmaintained.com/badge/resolution/crazy-max/ghaction-setup-docker.svg)](https://isitmaintained.com/project/crazy-max/ghaction-setup-docker) +# Support [![](https://isitmaintained.com/badge/resolution/docker/setup-docker-action.svg)](https://isitmaintained.com/project/docker/setup-docker-action) First, [be a good guy](https://github.com/kossnocorp/etiquette/blob/master/README.md). ## Reporting an issue -Please do a search in [open issues](https://github.com/crazy-max/ghaction-setup-docker/issues?utf8=%E2%9C%93&q=) to see if the issue or feature request has already been filed. +Please do a search in [open issues](https://github.com/docker/setup-docker-action/issues?utf8=%E2%9C%93&q=) to see if the issue or feature request has already been filed. If you find your issue already exists, make relevant comments and add your [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). Use a reaction in place of a "+1" comment. @@ -23,7 +23,7 @@ File a single issue per problem and feature request. The more information you can provide, the more likely someone will be successful reproducing the issue and finding a fix. -You are now ready to [create a new issue](https://github.com/crazy-max/ghaction-setup-docker/issues/new/choose)! +You are now ready to [create a new issue](https://github.com/docker/setup-docker-action/issues/new/choose)! ## Closure policy diff --git a/README.md b/README.md index 16bcaf0..a35facc 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -[![GitHub release](https://img.shields.io/github/release/crazy-max/ghaction-setup-docker.svg?style=flat-square)](https://github.com/crazy-max/ghaction-setup-docker/releases/latest) +[![GitHub release](https://img.shields.io/github/release/docker/setup-docker-action.svg?style=flat-square)](https://github.com/docker/setup-docker-action/releases/latest) [![GitHub marketplace](https://img.shields.io/badge/marketplace-docker--setup--docker-blue?logo=github&style=flat-square)](https://github.com/marketplace/actions/docker-setup-docker) -[![CI workflow](https://img.shields.io/github/actions/workflow/status/crazy-max/ghaction-setup-docker/ci.yml?branch=master&label=ci&logo=github&style=flat-square)](https://github.com/crazy-max/ghaction-setup-docker/actions?workflow=ci) -[![Test workflow](https://img.shields.io/github/actions/workflow/status/crazy-max/ghaction-setup-docker/test.yml?branch=master&label=test&logo=github&style=flat-square)](https://github.com/crazy-max/ghaction-setup-docker/actions?workflow=test) -[![Codecov](https://img.shields.io/codecov/c/github/crazy-max/ghaction-setup-docker?logo=codecov&style=flat-square)](https://codecov.io/gh/crazy-max/ghaction-setup-docker) +[![CI workflow](https://img.shields.io/github/actions/workflow/status/docker/setup-docker-action/ci.yml?branch=master&label=ci&logo=github&style=flat-square)](https://github.com/docker/setup-docker-action/actions?workflow=ci) +[![Test workflow](https://img.shields.io/github/actions/workflow/status/docker/setup-docker-action/test.yml?branch=master&label=test&logo=github&style=flat-square)](https://github.com/docker/setup-docker-action/actions?workflow=test) +[![Codecov](https://img.shields.io/codecov/c/github/docker/setup-docker-action?logo=codecov&style=flat-square)](https://codecov.io/gh/docker/setup-docker-action) ## About @@ -44,7 +44,7 @@ jobs: steps: - name: Set up Docker - uses: crazy-max/ghaction-setup-docker@v3 + uses: docker/setup-docker-action@v3 ``` ### Daemon configuration @@ -66,7 +66,7 @@ jobs: steps: - name: Set up Docker - uses: crazy-max/ghaction-setup-docker@v3 + uses: docker/setup-docker-action@v3 with: daemon-config: | { @@ -94,7 +94,7 @@ jobs: steps: - name: Set up Docker - uses: crazy-max/ghaction-setup-docker@v3 + uses: docker/setup-docker-action@v3 env: LIMA_START_ARGS: --cpus 4 --memory 8 ``` @@ -124,12 +124,8 @@ The following outputs are available ## Contributing -Want to contribute? Awesome! The most basic way to show your support is to star -the project, or to raise issues. You can also support this project by [**becoming a sponsor on GitHub**](https://github.com/sponsors/crazy-max) -or by making a [PayPal donation](https://www.paypal.me/crazyws) to ensure this -journey continues indefinitely! - -Thanks again for your support, it is much appreciated! :pray: +Want to contribute? Awesome! You can find information about contributing to +this project in the [CONTRIBUTING.md](/.github/CONTRIBUTING.md) ## License diff --git a/action.yml b/action.yml index 9aed512..5c3cc63 100644 --- a/action.yml +++ b/action.yml @@ -1,7 +1,7 @@ # https://help.github.com/en/articles/metadata-syntax-for-github-actions -name: 'Docker Setup Docker' -description: 'Set up Docker for use in GitHub Actions by downloading and installing a version of Docker CE' -author: 'crazy-max' +name: Docker Setup Docker +description: Set up Docker for use in GitHub Actions by downloading and installing a version of Docker CE +author: docker branding: icon: 'anchor' color: 'blue' diff --git a/package.json b/package.json index f9e9952..f646920 100644 --- a/package.json +++ b/package.json @@ -15,14 +15,14 @@ }, "repository": { "type": "git", - "url": "git+https://github.com/crazy-max/ghaction-setup-docker.git" + "url": "git+https://github.com/docker/setup-docker-action.git" }, "keywords": [ "actions", "docker", "engine" ], - "author": "CrazyMax", + "author": "Docker Inc.", "license": "Apache-2.0", "packageManager": "yarn@3.6.3", "dependencies": { From 57e629a437540d4ac848af1f976bf39ffa20743f Mon Sep 17 00:00:00 2001 From: CrazyMax Date: Wed, 13 Sep 2023 10:07:03 +0200 Subject: [PATCH 2/4] chore: update community files --- .github/CODE_OF_CONDUCT.md | 3 +++ .github/SECURITY.md | 12 ++++++++++++ .github/SUPPORT.md | 31 ------------------------------- 3 files changed, 15 insertions(+), 31 deletions(-) create mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 .github/SECURITY.md delete mode 100644 .github/SUPPORT.md diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..db44d7e --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,3 @@ +# Code of conduct + +- [Moby community guidelines](https://github.com/moby/moby/blob/master/CONTRIBUTING.md#moby-community-guidelines) diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 0000000..e839895 --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,12 @@ +# Reporting security issues + +The project maintainers take security seriously. If you discover a security +issue, please bring it to their attention right away! + +**Please _DO NOT_ file a public issue**, instead send your report privately to +[security@docker.com](mailto:security@docker.com). + +Security reports are greatly appreciated, and we will publicly thank you for it. +We also like to send gifts—if you'd like Docker swag, make sure to let +us know. We currently do not offer a paid security bounty program, but are not +ruling it out in the future. diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md deleted file mode 100644 index 3742f3b..0000000 --- a/.github/SUPPORT.md +++ /dev/null @@ -1,31 +0,0 @@ -# Support [![](https://isitmaintained.com/badge/resolution/docker/setup-docker-action.svg)](https://isitmaintained.com/project/docker/setup-docker-action) - -First, [be a good guy](https://github.com/kossnocorp/etiquette/blob/master/README.md). - -## Reporting an issue - -Please do a search in [open issues](https://github.com/docker/setup-docker-action/issues?utf8=%E2%9C%93&q=) to see if the issue or feature request has already been filed. - -If you find your issue already exists, make relevant comments and add your [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). Use a reaction in place of a "+1" comment. - -:+1: - upvote - -:-1: - downvote - -If you cannot find an existing issue that describes your bug or feature, submit an issue using the guidelines below. - -## Writing good bug reports and feature requests - -File a single issue per problem and feature request. - -* Do not enumerate multiple bugs or feature requests in the same issue. -* Do not add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar, but have different causes. - -The more information you can provide, the more likely someone will be successful reproducing the issue and finding a fix. - -You are now ready to [create a new issue](https://github.com/docker/setup-docker-action/issues/new/choose)! - -## Closure policy - -* Issues that don't have the information requested above (when applicable) will be closed immediately and the poster directed to the support guidelines. -* Issues that go a week without a response from original poster are subject to closure at our discretion. From eff8d999dc8c1af41fe8bf7f556b64563e9f88dc Mon Sep 17 00:00:00 2001 From: CrazyMax Date: Wed, 13 Sep 2023 10:07:09 +0200 Subject: [PATCH 3/4] chore: github form templates --- .github/ISSUE_TEMPLATE/bug.yml | 102 +++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 34 --------- .github/ISSUE_TEMPLATE/config.yml | 6 ++ .github/ISSUE_TEMPLATE/feature.yml | 15 ++++ 4 files changed, 123 insertions(+), 34 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..23e5782 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,102 @@ +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema +name: Bug Report +description: Report a bug +labels: + - status/triage + +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to report a bug! + If this is a security issue please report it to the [Docker Security team](mailto:security@docker.com). + Before submitting a bug report, check out the [Troubleshooting doc](https://github.com/docker/setup-docker-action/blob/master/TROUBLESHOOTING.md). + + - type: checkboxes + attributes: + label: Contributing guidelines + description: > + Make sure you've read the contributing guidelines before proceeding. + options: + - label: I've read the [contributing guidelines](https://github.com/docker/setup-docker-action/blob/master/.github/CONTRIBUTING.md) and wholeheartedly agree + required: true + + - type: checkboxes + attributes: + label: "I've found a bug, and:" + description: | + Make sure that your request fulfills all of the following requirements. + If one requirement cannot be satisfied, explain in detail why. + options: + - label: The documentation does not mention anything about my problem + - label: There are no open or closed issues that are related to my problem + + - type: textarea + attributes: + label: Description + description: > + Provide a brief description of the bug in 1-2 sentences. + validations: + required: true + + - type: textarea + attributes: + label: Expected behaviour + description: > + Describe precisely what you'd expect to happen. + validations: + required: true + + - type: textarea + attributes: + label: Actual behaviour + description: > + Describe precisely what is actually happening. + validations: + required: true + + - type: input + attributes: + label: Repository URL + description: > + Enter the URL of the repository where you are experiencing the + issue. If your repository is private, provide a link to a minimal + repository that reproduces the issue. + + - type: input + attributes: + label: Workflow run URL + description: > + Enter the URL of the GitHub Action workflow run if public (e.g. + `https://github.com///actions/runs/`) + + - type: textarea + attributes: + label: YAML workflow + description: | + Provide the YAML of the workflow that's causing the issue. + Make sure to remove any sensitive information. + render: yaml + validations: + required: true + + - type: textarea + attributes: + label: Workflow logs + description: > + [Attach](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/attaching-files) + the [log file of your workflow run](https://docs.github.com/en/actions/managing-workflow-runs/using-workflow-run-logs#downloading-logs) + and make sure to remove any sensitive information. + + - type: textarea + attributes: + label: Docker daemon logs + description: > + If applicable, provide the Docker logs available in post step. + render: text + + - type: textarea + attributes: + label: Additional info + description: | + Provide any additional information that could be useful. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index d50d109..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve ---- - -### Behaviour - -#### Steps to reproduce this issue - -1. -2. -3. - -#### Expected behaviour - -> Tell us what should happen - -#### Actual behaviour - -> Tell us what happens instead - -### Configuration - -* Repository URL (if public): -* Build URL (if public): - -```yml -# paste your YAML workflow file here and remove sensitive data -``` - -### Logs - -> Download the [log file of your build](https://docs.github.com/en/actions/managing-workflow-runs/using-workflow-run-logs#downloading-logs) -> and [attach it](https://docs.github.com/en/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests) to this issue. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..448f3b3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,6 @@ +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser +blank_issues_enabled: true +contact_links: + - name: Questions and Discussions + url: https://github.com/docker/setup-docker-action/discussions/new + about: Use Github Discussions to ask questions and/or open discussion topics. diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..6ab7568 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,15 @@ +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema +name: Feature request +description: Missing functionality? Come tell us about it! +labels: + - kind/enhancement + - status/triage + +body: + - type: textarea + id: description + attributes: + label: Description + description: What is the feature you want to see? + validations: + required: true From 07f0e609c6c4b7f78520797cd5d0596093f22974 Mon Sep 17 00:00:00 2001 From: CrazyMax Date: Thu, 12 Oct 2023 16:38:07 +0200 Subject: [PATCH 4/4] docs: note about action usage --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index a35facc..f2c032f 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,13 @@ GitHub Action to set up (download and install) [Docker CE](https://docs.docker.com/engine/). Works on Linux, macOS and Windows. +> [!NOTE] +> This action is useful if you want to pin against a specific Docker version or +> set up a custom daemon configuration or if Docker is not available on your +> runner. If you're using [GitHub-hosted runners](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources) +> on Linux or Windows, Docker is already up and running, so it might not be +> necessary to use this action. + > [!WARNING] > Does not work on macOS runners with ARM architecture (no nested virtualization): > * https://github.com/crazy-max/ghaction-setup-docker/pull/53