GitHub Actions: Automating Your Workflow

Welcome to the fourteenth blog of the serires!

GitHub Actions is a powerful automation tool provided by GitHub that allows you to automate various tasks and workflows within your repositories. With GitHub Actions, you can build, test, and deploy your code automatically, saving time and ensuring consistent results. In this blog post, we will explore the capabilities of GitHub Actions, learn how to set up workflows, and showcase examples of common automation scenarios.

Understanding GitHub Actions

GitHub Actions allows you to define custom workflows using YAML files. A workflow consists of one or more jobs, and each job runs on a separate virtual environment called a runner. You can specify the events that trigger the workflow, such as push, pull request, or a scheduled time. Each job can execute a series of steps, which can include running commands, executing scripts, or invoking external actions.

Creating a Workflow

To create a GitHub Actions workflow, follow these steps:

1. Go to your GitHub repository's page.
2. Click on the "Actions" tab.
3. Click on the "Set up a workflow yourself" link or choose a pre-defined workflow template.
4. GitHub will open a new file in the .github/workflows directory. Provide a meaningful name for the workflow, such as main.yml.
5. Define the workflow using YAML syntax.

Let's take a look at a simple example of a workflow that runs on every push to the main branch:

name: CI

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Build and test
        run: |
          npm install
          npm run build
          npm run test

In this example, the workflow is triggered by a push event on the main branch. The build job runs on an ubuntu-latest runner. The steps in the job include checking out the code and performing build and test operations.

Using Actions

GitHub Actions provides a vast marketplace of pre-built actions that you can use in your workflows. Actions are reusable units of code that perform specific tasks. You can find actions for a wide range of use cases, such as deploying to cloud platforms, sending notifications, or running tests.

To use an action in your workflow, you can specify it in the steps section of a job. Here's an example that uses the actions/checkout and actions/npm actions:

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Build and test
        run: |
          npm install
          npm run build
          npm run test

      - name: Deploy to GitHub Pages
        uses: JamesIves/github-pages-deploy-action@4.1.0
        with:
          branch: gh-pages
          folder: dist

In this example, after building and testing the code, the workflow uses the JamesIves/github-pages-deploy-action action to deploy the contents of the dist folder to the gh-pages branch.

Secrets and Environment Variables

GitHub Actions allows you to store and use secrets securely in your workflows. Secrets are encrypted and can be accessed within your workflow using environment variables.

To set up a secret, go to your repository's page, click on "Settings," then "Secrets," and finally "New repository secret." You can then reference the secret in your workflow using the secrets.<secret-name> syntax.

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - name: Set up environment
        run: |
          echo "DATABASE_URL=${{ secrets.DATABASE_URL }}" >> $GITHUB_ENV

In this example, the DATABASE_URL secret is set as an environment variable within the workflow.

Workflow Visualization

GitHub provides a visual representation of your workflows, making it easier to understand the overall process and identify potential issues. You can access the workflow visualization by navigating to the "Actions" tab in your repository and selecting the workflow of interest.

Conclusion

GitHub Actions offers a powerful automation platform that allows you to streamline your development workflows. By defining custom workflows, leveraging pre-built actions, and utilizing secrets and environment variables, you can automate tasks such as building, testing, and deploying your code. Explore the vast marketplace of actions and experiment with different workflows to enhance your development process. GitHub Actions empowers you to save time, increase productivity, and ensure the consistency and quality of your software projects. Start automating your workflows with GitHub Actions today!

Thank you for reading and do let me know your thoughts in comments!

Connect With Me :

Pratik KaleFollow

Software Enginner @ Impulsive Web | Organizer @GDG Cloud Pune | Google DSC Lead '21 | Tech Geek 💻 | Learner 📔

Website | Twitter | Instagram | Mail