GitHub - Creating a Public Repository

Now that we have installed Git, created a GitHub account with enhanced privacy and security settings, it's time to create a repository for our CI/CD pipeline. In this article, we'll focus on creating a public GitHub repository, understanding the benefits of public repositories for CI/CD workflows, and performing initial repository setup.

Creating a New Public Repository in GitHub

Let's walk through the process of creating a new public repository through GitHub's web interface:

1. Log in to your GitHub account at GitHub's website

2. Navigate to the repository creation page by either:

   • Clicking the "+" icon in the upper right corner and selecting "New repository"

   • Going directly to github.com/new

3. Fill in the repository details:

   • Owner: Select your personal account or an organisation

   • Repository name: Choose a descriptive name related to your project (e.g., "my-cicd-pipeline")

   • Description (optional): Add a brief description of your project

   • Visibility: Select "Public"

4. Initialise your repository (optional but recommended):

   • Check "Add a README file" to create an initial commit

   • Add a .gitignore file appropriate for your project language

   • Choose a licence that suits your needs

5. Click "Create repository"

Why Choose a Public Repository for CI/CD?

While private repositories are essential for proprietary code, public repositories offer distinct advantages for CI/CD pipelines:

Cost Benefits for GitHub Actions

• Free compute resources for CI/CD workflows: According to GitHub's documentation, "GitHub Actions usage is free for standard GitHub-hosted runners in public repositories, and for self-hosted runners." This free allocation means you can run extensive CI/CD workflows without incurring costs

• Unlimited build minutes: Unlike private repositories that have monthly limits, public repositories have no restrictions on build minutes

• Access to larger runners: Public repositories often have access to more powerful GitHub-hosted runners

Additional Benefits of Public Repositories

Beyond cost savings, public repositories offer:

• Community contributions: Open-source collaboration can improve your pipeline configurations

• Enhanced visibility: Showcase your CI/CD expertise to potential employers or clients

• Educational value: Help others learn from your CI/CD implementations

• Integration advantages: Many third-party tools offer free tiers for public repositories

Editing Your README.md with GitHub's Web Interface

Now that your repository is created, let's explore how to edit your README.md file directly through GitHub's web interface. This approach is perfect for quick updates or when you're away from your development environment.

Why the README.md File Matters

• First impression: The README is often the first thing visitors see when they find your repository

• Project documentation: It provides essential information about your project's purpose and usage

• CI/CD context: For our CI/CD pipeline, it will help outline our automation strategy

Using GitHub's Web Editor

1. Navigate to your repository on GitHub

2. Locate and click on the README.md file in the file list

3. Click the pencil icon (Edit this file) in the upper right corner of the file view

4. Make your changes using Markdown formatting:

   • The editor provides a toolbar for basic Markdown formatting

   • You can switch between "Edit" and "Preview" tabs to see how your changes will look

Advanced Web Editing Features

GitHub's web interface offers several helpful features:

• Markdown toolbar: Use the formatting toolbar to add headers, lists, links, and other Markdown elements

• Preview changes: Toggle between edit and preview modes to see how your Markdown will render

• File path navigation: Add or edit files in different directories by navigating through the file path

• Web IDE: For more complex edits, click the "." key on your keyboard while viewing your repository to launch GitHub's web-based IDE. This launches a VSCode-like editor right in your browser.

  • Note that the URL changes from github.com to github.dev (e.g. https://github.com/nickromney/n-dotfiles/blob/main/README.md in the default view becomes https://github.dev/nickromney/n-dotfiles/blob/main/README.md)

  • To exit the Web IDE, from the menu at the top left, choose "Go to Repository"

Creating a Well-Structured README for CI/CD

A good README for your CI/CD project should include:

# My CI/CD Pipeline

A comprehensive CI/CD pipeline using GitHub Actions for automated testing and deployment.

## Overview

This repository demonstrates a modern CI/CD workflow that includes:

- Automated testing
- Code quality checks
- Continuous deployment

## Pipeline Status

[![CI/CD Pipeline](https://github.com/yourusername/your-repo-name/actions/workflows/main.yml/badge.svg)](https://github.com/yourusername/your-repo-name/actions/workflows/main.yml)

## Documentation

Documentation for the pipeline setup will be added as the project progresses.

Committing Your Changes

After editing your README:

1. Scroll to the bottom of the editing page

2. Add a meaningful commit message describing your changes

   • For example: "Update README with CI/CD pipeline overview"

3. Choose whether to commit directly to the main branch or create a new branch for a pull request

   • For simple README changes, committing directly to main is typically fine

   • For more substantial changes, consider creating a pull request

4. Click "Commit changes"

Conclusion and Next Steps

You've now created a public GitHub repository and learned how to edit your README.md file directly through GitHub's web interface. These foundational steps prepare your project for CI/CD implementation while taking advantage of the cost benefits and collaborative nature of public repositories.

In our next article, we'll explore how to set up SSH commit signing for your repository, ensuring the security and verification of your code contributions.

Stay tuned for more practical CI/CD tips and techniques!