feat: allow selection of platforms to build the custom flavor on (#6950)

* feat: allow selection of platforms to build the custom flavor on

* [MegaLinter] Apply linters fixes

---------

Co-authored-by: bdovaz <[email protected]>

Author: bdovaz

.automation/build.py

@@ -3976,13 +3976,16 @@ def build_custom_flavor(dockerfile):
     work_dir = (
         "/megalinter-builder" if os.path.isdir("/megalinter-builder") else REPO_HOME
     )
+    platform = os.getenv("CUSTOM_FLAVOR_PLATFORM", "linux/amd64")
     tag_id = os.getenv("CUSTOM_FLAVOR_BUILD_REPO", "megalinter-custom").replace(
         "/", "_"
     )
     command = [
         "docker",
         "buildx",
         "build",
+        "--platform",
+        platform,
         "-t",
         tag_id,
         "-f",
@@ -3991,6 +3994,7 @@ def build_custom_flavor(dockerfile):
         "id=GITHUB_TOKEN",
         work_dir,
     ]
+    logging.info("Platforms to build on: " + platform)
     logging.info("Running command: " + " ".join(command))
     process = subprocess.run(
         command,

docs/custom-flavors.md

@@ -18,7 +18,7 @@ You can easily generate your own MegaLinter custom flavor using the `mega-linter
 
 - Create a new GitHub public repository whose name starts with `megalinter-custom-flavor` (example: `megalinter-custom-flavor-npm-groovy-lint`), with default README checked.
 
-![](assets/images/custom-flavor-new-repo.png)
+![GitHub form to create a repository](assets/images/custom-flavor-new-repo.png)
 
 ### Clone your new repository locally
 
@@ -35,7 +35,7 @@ npx mega-linter-runner@beta --custom-flavor-setup
 
 You can also send the list of linters as parameters, available from the logs of any official MegaLinter flavor (if you don't see it, make sure `FLAVOR_SUGGESTIONS: true` is defined in your `.mega-linter.yml` config file).
 
-![](assets/images/custom-flavor-command.png)
+![Example command to generate the custom flavor](assets/images/custom-flavor-command.png)
 
 ```bash
 npx mega-linter-runner@beta --custom-flavor-setup --custom-flavor-linters "PYTHON_BANDIT,PYTHON_BLACK,PYTHON_RUFF,REPOSITORY_TRIVY"
@@ -45,23 +45,40 @@ npx mega-linter-runner@beta --custom-flavor-setup --custom-flavor-linters "PYTHO
 
 Select your custom flavor label and the linters you want to include.
 
-![](assets/images/custom-flavor-linter-select.png)
+![Selection of linters in the custom flavor](assets/images/custom-flavor-linter-select.png)
 
 ### Generated files
 
 The generator will create all necessary configuration files, GitHub Actions workflows, and documentation in your repository.
 
 Two workflows are generated:
+
 - **megalinter-custom-flavor-builder.yml**: Builds and publishes your custom flavor Docker image
 - **check-new-megalinter-version.yml**: Automatically checks daily for new MegaLinter releases and creates matching releases in your repository
 
-![](assets/images/custom-flavor-generated-files.png)
+![Custom flavor generated files in VS Code](assets/images/custom-flavor-generated-files.png)
+
+### Optional: Generate the image for ARM
+
+> **Important:** Check the [linters you have selected](all_linters.md) in your flavor to see if they are compatible with `linux/arm64` platform.
+
+To build the image for ARM as well, edit **megalinter-custom-flavor-builder.yml** and change:
+
+```yml
+platform: "linux/amd64"
+```
+
+To:
+
+```yml
+platform: "linux/amd64,linux/arm64"
+```
 
 ### Commit and push your changes
 
 Commit and push the generated files to GitHub.
 
-![](assets/images/custom-flavor-commit-push.png)
+![Commit in VS Code](assets/images/custom-flavor-commit-push.png)
 
 ### Configure Personal Access Token (Required)
 
@@ -106,17 +123,15 @@ Your custom flavor will be built and published automatically in two ways:
    - Push to any branch (except main) to build a `beta` tagged image
    - Manually run the `megalinter-custom-flavor-builder` workflow
 
-![](assets/images/custom-flavor-release-1.png)
+![Creating a GitHub release checks](assets/images/custom-flavor-release-1.png)
 
-![](assets/images/custom-flavor-release-2.png)
-
-![](assets/images/custom-flavor-build-job.png)
+![Creating a GitHub release form](assets/images/custom-flavor-release-2.png)
 
 ## Use a Custom Flavor
 
 Follow [MegaLinter installation guide](https://megalinter.io/latest/install-assisted/), and replace related elements in the workflow.
 
-![](assets/images/custom-flavor-run.png)
+![Running a custom flavor workflow](assets/images/custom-flavor-run.png)
 
 ### GitHub Action
 
@@ -175,11 +190,3 @@ Your custom flavor automatically stays up to date with MegaLinter releases:
 3. The builder workflow will automatically create your custom flavor using that MegaLinter version
 
 **Troubleshooting**: If automatic version checking isn't working, ensure you have configured the `PAT_TOKEN` secret as described in the setup instructions above.
-
-
-
-
-
-
-
-

flavors/custom-builder/action.yml

@@ -6,6 +6,10 @@ inputs:
   megalinter-custom-flavor-builder-tag:
     description: "Tag of the megalinter-custom-flavor-builder Docker image to use"
     required: true
+  platform:
+    description: "The platform(s) it will build on"
+    required: true
+    default: "linux/amd64"
   is-latest:
     description: "Is this the latest version of the custom flavor?"
     required: true
@@ -32,6 +36,7 @@ runs:
           -v /var/run/docker.sock:/var/run/docker.sock:rw \
           -v ${{ github.workspace }}:/github/workspace \
             -e GITHUB_TOKEN=${{ env.GITHUB_TOKEN }} \
+            -e CUSTOM_FLAVOR_PLATFORM=${{ inputs.platform }} \
             -e CUSTOM_FLAVOR_BUILD_REPO=${{ env.CUSTOM_FLAVOR_BUILD_REPO }} \
             -e CUSTOM_FLAVOR_BUILD_REPO_URL=${{ env.CUSTOM_FLAVOR_BUILD_REPO_URL }} \
             -e CUSTOM_FLAVOR_BUILD_USER=${{ env.CUSTOM_FLAVOR_BUILD_USER }} \

mega-linter-runner/generators/mega-linter-custom-flavor/templates/megalinter-custom-flavor-builder.yml

@@ -107,6 +107,7 @@ jobs:
         uses: oxsecurity/megalinter/flavors/custom-builder@main
         with:
           megalinter-custom-flavor-builder-tag: ${{ steps.determine-tag.outputs.tag }}
+          platform: "linux/amd64"
           is-latest: ${{ steps.determine-tag.outputs.is-latest }}
           upload-to-ghcr: "true"
           upload-to-dockerhub: ${{ secrets.DOCKERHUB_USERNAME != '' && secrets.DOCKERHUB_PASSWORD != '' && 'true' || 'false' }}