Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
database

GitHub Action

Github Repository Metadata

1.2

Github Repository Metadata

database

Github Repository Metadata

Github Action exposes useful metadata as environment variable which can be called / used in a workflow

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Github Repository Metadata

              
  uses: varunsridharan/action-repository-meta@1.2
Learn more about this action in varunsridharan/action-repository-meta

Choose a version

Repository Meta - Github Action

Github Action exposes useful metadata as environment variable which can be called / used in a workflow

📥 ENV Variable

Below listed variables are set by this action when used

Repository Related Variables

ENV NAME Description Example
REPOSITORY_FULL_NAME provide exact repo name myname/test-repo
REPOSITORY_SLUG provide exact slug for current repo myname/test-repo => test-repo
REPOSITORY_NAME provide readable name test-repo => Test Repo
REPOSITORY_IS_PRIVATE sets to yes if its a private repo yes
REPOSITORY_IS_FORK sets to yes if its a forked repo yes
REPOSITORY_GITHUB_URL provides github url for current repo https://github.com/myname/test-repo
REPOSITORY_HOMEPAGE_URL provides url which is set in repo settings https://your-website.com
REPOSITORY_DESCRIPTION provides value which is set in repo settings Your Custom Description
REPOSITORY_CREATED_AT provides created at date 2020-06-03T07:57:39Z
REPOSITORY_UPDATED_AT provides updated at date 2020-07-02T07:01:30Z
REPOSITORY_PUSHED_AT provides pushed at date 2020-07-02T07:01:28Z
REPOSITORY_DEFAULT_BRANCH provides branch name which is set as default master
REPOSITORY_TOPICS provides current repository topics ["topic1","topic2"]
SHA_SHORT The shortened commit SHA (8 characters) that triggered the workflow. ffac537e

🚀 Usage

Example Workflow

  - name: "Repository Meta"
    uses: varunsridharan/action-repository-meta@master
    env:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  - run: echo $REPOSITORY_HOMEPAGE_URL
    env:
      REPOSITORY_HOMEPAGE_URL: ${{ env.REPOSITORY_HOMEPAGE_URL }}

📝 Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Checkout CHANGELOG.md

🤝 Contributing

If you would like to help, please take a look at the list of issues.

💰 Sponsor

I fell in love with open-source in 2013 and there has been no looking back since! You can read more about me here. If you, or your company, use any of my projects or like what I’m doing, kindly consider backing me. I'm in this for the long run.

  • ☕ How about we get to know each other over coffee? Buy me a cup for just $9.99
  • ☕️☕️ How about buying me just 2 cups of coffee each month? You can do that for as little as $9.99
  • 🔰 We love bettering open-source projects. Support 1-hour of open-source maintenance for $24.99 one-time?
  • 🚀 Love open-source tools? Me too! How about supporting one hour of open-source development for just $49.99 one-time ?

📜 License & Conduct

📣 Feedback

  • ⭐ This repository if this project helped you! 😉
  • Create An 🔧 Issue if you need help / found a bug

Connect & Say 👋

Built With ♥ By Varun Sridharan 🇮🇳