Skip to content

Latest commit

 

History

History
225 lines (167 loc) · 8.33 KB

README.md

File metadata and controls

225 lines (167 loc) · 8.33 KB
Raw

YAML FILE (Copy and paste into your workflow.)

# Trigger the workflow on each push to the main branch
on:
  push:
    branches: [main]

# Define the jobs to be executed
jobs:
  # Job for publishing the blog post
  publish-post:
    # Operating system for the job
    runs-on: ubuntu-latest

    # Steps to be executed in the job
    steps:
      # Step to checkout the code
      - name: Checkout code
        uses: actions/checkout@v2

      # Step to extract repository information
      - name: Extract Repo Info
        env:
          SECRET_API_KEY: ${{ secrets.Githash_API_TOKEN }}
        id: repo-info
        run: |
          # Extract GitHub repository URL
          REPO_URL="https://github.com/${GITHUB_REPOSITORY}"
          echo "GitHub Repo URL: $REPO_URL"

          # Extract GitHub repository name
          REPO_NAME=$(echo $GITHUB_REPOSITORY | awk -F/ '{print $2}')
          echo "Repository Name: $REPO_NAME"

          # Extract GitHub username
          USER_NAME=$(echo $GITHUB_REPOSITORY | awk -F/ '{print $1}')
          echo "GitHub Username: $USER_NAME"

          API_KEY=$SECRET_API_KEY
          echo "API Key: $API_KEY"

          # Set the outputs for later steps
          echo "::set-output name=repo-url::$REPO_URL"
          echo "::set-output name=repo-name::$REPO_NAME"
          echo "::set-output name=user-name::$USER_NAME"
          echo "::set-output name=secret-api-key::$API_KEY"

      # Step to extract commit message
      - name: Extract Commit Message
        id: extract-commit-message
        run: |
          COMMIT_MESSAGE=$(git log --format=%B -n 1)
          echo "Commit Message: $COMMIT_MESSAGE"
          echo "::set-output name=commit-message::$COMMIT_MESSAGE"

      # Step to check commit message and send data to backend accordingly
      - name: Check Commit Message and Send Data
        run: |
          # Retrieve outputs from previous steps
          REPO_URL="${{ steps.repo-info.outputs.repo-url }}"
          REPO_NAME="${{ steps.repo-info.outputs.repo-name }}"
          USER_NAME="${{ steps.repo-info.outputs.user-name }}"
          SECRET_API_KEY="${{ steps.repo-info.outputs.secret-api-key }}"
          COMMIT_MESSAGE="${{ steps.extract-commit-message.outputs.commit-message }}"

          # Check if commit message contains "avoid publish"
          if [[ $COMMIT_MESSAGE == *"avoid publish"* ]]; then
            echo "Commit message contains 'avoid publish'. Skipping publishing."
            exit 0  # Skip the rest of the steps
          fi

          # Check if commit message contains "own md"
          if [[ $COMMIT_MESSAGE == *"my md"* ]]; then
            MARKDOWN_CONTENT=$(cat markdown.md | jq -s -R '.' | sed -e 's/^"//' -e 's/"$//')
            echo "Markdown Content: $MARKDOWN_CONTENT"
          else
            MARKDOWN_CONTENT=""
          fi

          # Include the secret, commit message, and markdown content in the payload
          curl_data="{\"githubRepoUrl\": \"$REPO_URL\", \"repoName\": \"$REPO_NAME\", \"userName\": \"$USER_NAME\", \"secretApiKey\": \"$SECRET_API_KEY\", \"commitMessage\": \"$COMMIT_MESSAGE\", \"markdownContent\": \"$MARKDOWN_CONTENT\"}"
          echo "Data to be sent: $curl_data"

          # Use curl to send data to the backend API
          if ! curl -X POST 'https://githash-server.onrender.com/api/publish' \
              -H "Content-Type: application/json" \
              -d "$curl_data"; then
            echo "Error: Failed to send data to the backend."
            exit 1
          fi

Full Explanation :

In this section I will provide the full explanation of the above yml script. 👇

Trigger Configuration

The workflow is triggered on each push to the main branch.

on:
  push:
    branches: [main]

Job Definitions

The workflow consists of one job named publish-post, which runs on the latest version of the Ubuntu operating system.

jobs:
  publish-post:
    runs-on: ubuntu-latest

Steps in the Job

Step 1: Checkout Code

This step checks out the code using the actions/checkout action.

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

Step 2: Extract Repository Information

This step extracts information about the GitHub repository, including the repository URL, repository name, and username. It also sets up an API key from GitHub secrets.

- name: Extract Repo Info
  env:
    SECRET_API_KEY: ${{ secrets.Githash_API_TOKEN }}
  id: repo-info
  run: |
    # ... (code for extracting repository information)

Step 3: Extract Commit Message

This step extracts the commit message from the latest commit.

- name: Extract Commit Message
  id: extract-commit-message
  run: |
    # ... (code for extracting commit message)

Step 4: Check Commit Message and Send Data

This step checks the commit message for specific phrases and sends relevant data to a backend API accordingly. If the commit message contains "avoid publish," the publication is skipped. If it contains "my md," it also extracts and sends Markdown content.

- name: Check Commit Message and Send Data
  run: |
    # ... (code for checking commit message and sending data to backend)

Additional Notes

  • The workflow utilizes environment variables and outputs from previous steps.
  • Markdown content is extracted from a file named markdown.md if the commit message contains "my md."
  • Data is sent to a backend API (https://githash-server.onrender.com/api/publish) using the curl command.

Overview

Introducing GitHash - a powerful open-source web application that seamlessly converts your GitHub commits into engaging Hashnode articles. GitHash goes beyond GitHub actions; it's a complete web application with a user-friendly UI dashboard, giving you control over configurations and updates to uniquely showcase your work.

Project Introduction 🙋‍♂️

GitHash, licensed under MIT, utilizes GitHub actions and the GitHub API to effortlessly publish articles on Hashnode. Share detailed insights into your latest GitHub commits, highlighting changes, file modifications, and showcasing code modifications.

Features ⚙

  • Automatic Article Generation: GitHash converts your latest commits into engaging Hashnode articles.

  • Configurable Markdown: Customize and publish your markdown structure (markdown.md) after each repository push.

  • Skip Publishing Option: Use the commit message "avoid publish" to skip article publishing while pushing code to the repository.

  • Custom Markdown: Include a markdown[.]md file in the root of the repository and add the phrase "my md" in the commit message to publish your custom markdown.

  • Dashboard: Track publishing processes, manage Hashnode credentials, view tracked repositories, and access published blog posts.

Demo 💻

Explore the GitHash website with features like authentication, adding personal access tokens, tracking repositories, and viewing published blog posts.

How to Use 🔁

  1. Login: Authenticate via Google account.

  2. Add GitHash Token: Include the GitHash token (generated by the application) in the repository secrets labeled as Githash_API_TOKEN.

  3. Add Hashnode Credentials: Connect GitHash with Hashnode by adding the publication ID and Personal Access Token.

  4. Workflow Setup: Add the provided YAML script to the repository actions.

  5. Push Changes: Test the application functionality by making changes to your codebase, adding a commit message, and pushing changes to the repository.

Tech Stack 👩‍💻

  • Frontend: React JS
  • Backend: Express JS
  • Database: MongoDB Atlas
  • Summary Generation: Mindsdb
  • APIs: GitHub API, Hashnode GraphQL API

What I Learned 💡

  • Efficient use of GraphQL API for queries and mutations.
  • Proficiency in GitHub Actions for workflow automation.
  • Flexibility and capabilities of GitHub API.

Important Links 🔗

Acknowledgments 🙌

Thanks to the community on Discord, especially Favourite Jome, for the amazing support during the hackathon.

Connect with Me 🐦

Follow me on Twitter for updates and discussions.