Search for a command to run...
A tech enthusiast and cloud engineer with a passion for sharing knowledge. Through this blog, I delve into the world of Cloud computing, DevOps, Cloud Security and the latest in tech trends. Join me on this journey as I explore and demystify the digital world. Outside of tech, I’m an avid soccer fan and enjoy writing. This blog combines my professional insights with my creative passions.
No comments yet. Be the first to comment.
When working with Linux filesystems, particularly XFS, you may occasionally run into issues when attempting to mount partitions. Recently, I encountered a problem with mounting an XFS filesystem, which provided valuable insights into troubleshooting ...
When conducting performance testing, resource allocation plays a critical role in ensuring that your application not only meets performance expectations but also operates efficiently. Deciding whether to start with high resource allocations and adjus...
As businesses evolve and adopt cloud technologies, the management of sensitive data becomes increasingly crucial. Azure Key Vault, a cloud service provided by Microsoft, offers a secure storage solution for cryptographic keys, secrets, and certificat...
I am tempted to call the Azure Automation Service a "Task Scheduler on steroids". It is of course an oversimplification as the Azure Automation service is used for more than just scheduling tasks but I guess it can serve as a good introduction to wha...
GitHub Actions provides a powerful way to automate workflows in your repositories. By creating custom actions, you can encapsulate reusable workflows, scripts, and automation steps into a single unit.
In this article, we will walk through the steps of creating a custom GitHub Action (based on Docker), using a practical example of an action that checks the number of public repositories in the Microsoft Azure organization.
To get started, either create a new GitHub repository or navigate to an existing one where you want to create your custom action. The repository will contain all the necessary files for your action.
Clone the repository for local development and begin to add files. Your repository should contain the following structure for the custom action:
my-github-action/
│
├── action.yml # Metadata file
├── Dockerfile # Docker configuration file
└── entrypoint.sh # Script to execute inside the container
action.ymlThe action.yml file defines the inputs, outputs, and execution environment of your custom action. Here’s an example:
name: 'Azure Repo Counter Action'
description: 'Fetches the public repository count for the Microsoft Azure GitHub organization'
inputs:
my-input:
description: 'A placeholder input value'
required: true
default: 'default value'
outputs:
my-output:
description: 'The number of public repositories'
runs:
using: 'docker'
image: 'Dockerfile'
args:
- ${{ inputs.my-input }}
This file defines the name of the action, input parameters, and outputs. The runs section specifies that the action will be executed in a Docker container.
DockerfileThe Dockerfile describes how to build the Docker image that will run the action. Here’s a simple example:
FROM ubuntu:20.04
RUN apt-get update && apt-get install -y \
curl \
jq
COPY entrypoint.sh /entrypoint.sh
RUN chmod +x /entrypoint.sh
ENTRYPOINT ["/entrypoint.sh"]
In this file:
We’re using an Ubuntu base image.
Installing curl to make HTTP requests and jq to process JSON data.
Copying and setting permissions for the entrypoint.sh script.
entrypoint.shThe entrypoint.sh script will be executed when the action runs. In this case, it fetches the number of public repositories for the Microsoft Azure GitHub organization and sets the value as an output.
#!/bin/bash
# Get the input value
MY_INPUT=$1
# Fetch public repositories from the Microsoft Azure organization using GitHub API
DATA=$(curl -s https://api.github.com/orgs/Azure)
# Use jq to parse the data and get the public repository count
REPO_COUNT=$(echo "$DATA" | jq '.public_repos')
# Output the number of public repositories
echo "Microsoft Azure organization has $REPO_COUNT public repositories"
# Set an output variable using the environment file method (Optional)
echo "my-output=$REPO_COUNT" >> "$GITHUB_ENV"
This script fetches data from the GitHub API, processes it using jq, and then uses the GITHUB_ENV file to pass the result to the workflow.
Once everything is set up, push your changes to the repository:
git add .
git commit -m "Add custom Docker GitHub Action"
git push origin main
To use your custom action, create a new workflow file in the .github/workflows/ directory. Here’s an example workflow:
name: Example Workflow
on: [push]
jobs:
my-job:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Run Azure Repo Counter Action
uses: ./ # Uses the custom action in the same repository
with:
my-input: "Fetching Azure repositories"
- name: Print output
run: echo "Public repositories in Microsoft Azure: ${{ env.my-output }}"
This workflow will:
Checkout the repository code.
Execute your custom action.
Output the number of public repositories in the Microsoft Azure organization.
Push changes to your repository, and GitHub Actions will automatically trigger the workflow. You can view the workflow’s execution in the "Actions" tab and see how your custom action performs.
By following this guide, you’ve created a reusable GitHub Action that runs in a Docker container, fetches data from the GitHub API, and returns a result to your workflow. You can expand this approach to create more sophisticated actions, integrate with other APIs, or automate any part of your DevOps pipelines. Container actions provide great flexibility, as they allow you to run any tool or script in a controlled environment.