OPSEXP-1357 Add migrate to actions table in README (#34)

Alfresco · Mar 29, 2022 · 3759714 · 3759714
1 parent 16cafb0
commit 3759714
Showing 1 changed file with 66 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -8,13 +8,76 @@ Shared [Travis CI](https://travis-ci.com/), [GitHub Actions](https://docs.github
 
 [![Build Status](https://travis-ci.com/Alfresco/alfresco-build-tools.svg?branch=master)](https://travis-ci.com/Alfresco/alfresco-build-tools)
 
+## Migrate from Travis to GitHub Action
+
+Hosted runners come with many bundled packages, see
+[Available Environments](https://github.com/actions/virtual-environments#available-environments)
+for details of what is already available when running GitHub Actions.
+
+Here follows a table to ease migrating Travis build that were using config offered by this repo:
+
+| Travis config file                        | GitHub action replacement                                         |
+|-------------------------------------------|-------------------------------------------------------------------|
+| .travis.aws-iam-authenticator_install.yml | Not yet determined                                                |
+| .travis.awscli_install.yml                | Preinstalled                                                      |
+| .travis.checkov_install.yml               | [setup-checkov](.github/actions/setup-checkov/action.yml)         |
+| .travis.common.yml                        | Not yet determined                                                |
+| .travis.docker-buildx_install.yml         | Not yet determined                                                |
+| .travis.docker_hub_login.yml              | [docker/login-action](#dockerlogin-action)                        |
+| .travis.docker_login.yml                  | [docker/login-action](#dockerlogin-action)                        |
+| .travis.gh_install.yml                    | Preinstalled                                                      |
+| .travis.helm-docs_install.yml             | [setup-helm-docs](.github/actions/setup-helm-docs/action.yml)     |
+| .travis.helm.yml                          | Not yet determined                                                |
+| .travis.helm_install.yml                  | Preinstalled                                                      |
+| .travis.home_bin_path.yml                 | Not yet determined                                                |
+| .travis.java.yml                          | Not yet determined                                                |
+| .travis.java_config.yml                   | Not yet determined                                                |
+| .travis.java_docker.yml                   | Not yet determined                                                |
+| .travis.jq_install.yml                    | Preinstalled                                                      |
+| .travis.kcadm_install.yml                 | Not yet determined                                                |
+| .travis.kubepug_install.yml               | [setup-kubepug](.github/actions/setup-kubepug/action.yml)         |
+| .travis.kubernetes_install.yml            | Preinstalled                                                      |
+| .travis.kubernetes_config.yml             | Not yet determined                                                |
+| .travis.kubernetes_install.yml            | Not yet determined                                                |
+| .travis.maven_config.yml                  | Not yet determined                                                |
+| .travis.pre-commit.yml                    | Not yet determined                                                |
+| .travis.rancher_cli_config.yml            | [setup-rancher-cli](.github/actions/setup-rancher-cli/action.yml) |
+| .travis.rancher_cli_install.yml           | [setup-rancher-cli](.github/actions/setup-rancher-cli/action.yml) |
+| .travis.rancher_cli_kubernetes_config.yml | [setup-rancher-cli](.github/actions/setup-rancher-cli/action.yml) |
+| .travis.srcclr_install.yml                | Not yet determined                                                |
+| .travis.terraform-docs_install.yml        | Not yet determined                                                |
+| .travis.terraform_install.yml             | Preinstalled                                                      |
+| .travis.tflint_install.yml                | Not yet determined                                                |
+| .travis.trigger.yml                       | Not yet determined                                                |
+| .travis.veracode.yml                      | Not yet determined                                                |
+| .travis.yml                               | Not yet determined                                                |
+| .travis.yq_install.yml                    | Preinstalled                                                      |
+
 ## GitHub Actions
 
 ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/alfresco/alfresco-build-tools/CI)
 
-Hosted runners come with many bundled packages, see
-[Available Environments](https://github.com/actions/virtual-environments#available-environments)
-for details.
+### docker/login-action
+
+Credentials should be already available via organization secrets or needs to be
+provided as repository secrets.
+
+```yml
+      - name: Login to Docker Hub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Login to Quay.io
+        uses: docker/login-action@v1
+        with:
+          registry: quay.io
+          username: ${{ secrets.QUAY_USERNAME }}
+          password: ${{ secrets.QUAY_PASSWORD }}
+```
+
+## GitHub Actions provided by us
 
 ### calculate-next-internal-version