🏷️ GitHub Properties as Envs

A GitHub Action to retrieve and validate custom repository properties, exporting them as outputs for your workflows.

---

📋 Table of Contents

• Features
• Usage
  • Basic Example
  • Available Outputs
• Inputs
• Use Cases
• Development
• Testing
• FAQ
• Contributing
• License
• Support

---

🚀 Features

• Retrieve custom properties from GitHub repositories
• Export properties as step-outputs for use in subsequent workflow steps
• Structured logs for debugging
• 100% test coverage with Jest

---

🔧 Usage

Basic Example

- name: Retrieve Custom Properties
  id: gca-properties
  uses: GoDllkE/github-properties-as-envs@v1.0.0
  with:
    github_token: ${{ secrets.some_personal_access_token }}
    repository_owner: ${{ github.repository_owner }}
    repository_name: ${{ github.event.repository.name }}
    validate_properties: true

- name: Use Properties
  run: |
    echo "Deploy method: ${{ steps.gca-properties.outputs.deploy }}"
    echo "Framework: ${{ steps.gca-properties.outputs.framework }}"

⚙️ Inputs

Input	Required	Default	Description
github_token	Yes	-	GitHub token (PAT recommended)
repository_owner	Yes	-	Repository owner
repository_name	Yes	-	Repository name

🎯 Use Cases

• Reusable Workflows: Centralize property management for multiple repositories.
• CI/CD Automation: Use exported properties for deployment, notifications, and more.

---

🛠️ Development

Prerequisites

• Node.js 18+
• npm 8+
• Git

Setup

git clone https://github.com/GoDllkE/github-properties-as-envs.git
cd github-properties-as-envs
npm install
npm run prepare

Build

npm run build

---

🧪 Testing

• 100% code coverage with Jest
• Unit and integration tests for all core functions

npm test

Test structure:

tests/
├── main.test.js
├── getRepositoryProperties.test.js
├── validateInputs.test.js
├── exportGithubOutput.test.js
├── validateCredentials.test.js
├── filterRepoProperties.test.js
├── main.test.js

---

🤝 Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines.

---

📄 License

This project is licensed under the MIT License.

---

👥 Support

• Email me
• GitHub Issues
• GitHub Discussions

---

Made with ❤️ by GoDllkE

⭐ Star this project • 📝 Report a bug • 💡 Suggest a feature