{"id":25437647,"url":"https://github.com/sudoblark/sudoblark.github-actions.library","last_synced_at":"2026-04-30T14:32:30.577Z","repository":{"id":277897879,"uuid":"933854486","full_name":"sudoblark/sudoblark.github-actions.library","owner":"sudoblark","description":"Template library of re-usable components for usage in GitHub Actions. - repo managed by sudoblark.terraform.github","archived":false,"fork":false,"pushed_at":"2025-03-03T11:08:33.000Z","size":49,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-03T11:39:33.319Z","etag":null,"topics":["github-actions","library","yaml"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sudoblark.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-16T20:45:21.000Z","updated_at":"2025-03-03T11:08:35.000Z","dependencies_parsed_at":"2025-02-16T21:38:02.633Z","dependency_job_id":null,"html_url":"https://github.com/sudoblark/sudoblark.github-actions.library","commit_stats":null,"previous_names":["sudoblark/sudoblark.github-actions.library"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sudoblark%2Fsudoblark.github-actions.library","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sudoblark%2Fsudoblark.github-actions.library/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sudoblark%2Fsudoblark.github-actions.library/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sudoblark%2Fsudoblark.github-actions.library/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sudoblark","download_url":"https://codeload.github.com/sudoblark/sudoblark.github-actions.library/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254283350,"owners_count":22045141,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-actions","library","yaml"],"created_at":"2025-02-17T09:19:02.661Z","updated_at":"2026-04-30T14:32:30.570Z","avatar_url":"https://github.com/sudoblark.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca id=\"readme-top\"\u003e\u003c/a\u003e\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/sudoblark/sudoblark.github-actions.library\"\u003e\n    \u003cimg src=\"docs/logo.png\" alt=\"Logo\" width=\"80\" height=\"80\"\u003e\n  \u003c/a\u003e\n\n\u003ch3 align=\"center\"\u003esudoblark.github-actions.library\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    Template library of re-usable components for usage in GitHub Actions. - repo managed by sudoblark.terraform.github\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#technical-documentation\"\u003eTechnical Documentation\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n## About The Project\n[![CD](https://github.com/sudoblark/sudoblark.github-actions.library/actions/workflows/release.yaml/badge.svg)](https://github.com/sudoblark/sudoblark.github-actions.library/actions/workflows/release.yaml)\n[![Version](https://img.shields.io/github/v/release/sudoblark/sudoblark.github-actions.library?label=action%20library\u0026sort=semver)](https://github.com/sudoblark/sudoblark.github-actions.library/releases)\n[![Docs](https://img.shields.io/badge/docs-latest-blue?logo=readthedocs)](https://sudoblark.github.io/sudoblark.github-actions.library/)\n[![License](https://img.shields.io/github/license/sudoblark/sudoblark.github-actions.library)](https://github.com/sudoblark/sudoblark.github-actions.library/blob/main/LICENSE.txt)\n\n\nThis repo contains a setup of re-usable GitHub composition [actions](https://docs.github.com/en/actions/sharing-automations/creating-actions/creating-a-composite-action).\n\nSpecifically it is a library of semantically versioned](https://semver.org) actions, intended to be used as off-the-shelf, standardised,\nbuilding blocks for CI/CD processes involving GitHub Actions.\n\nIt fulfills the same function that [sudoblark.azure-devops.library](https://github.com/sudoblark/sudoblark.azure-devops.library)\ndoes for Azure DevOps Pipelines.\n\nIn the instance that several of these composite actions, when combined, fulfill a use-case this is either done via:\n\n- Direct instantation in a caller repo\n- As a re-usable workflow via [sudoblark.github-actions.workflows](https://github.com/sudoblark/sudoblark.github-actions.workflows)\n\nThe live documentation base for this project is [here](https://sudoblark.github.io/sudoblark.github-actions.library/latest).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\u003c!-- TECHNICAL DOCUMENTATION --\u003e\n### Technical Documentation\n\nmkdocs is used in order to auto-generation documentation. It is configured via\nthe [docs/mkdocs.yml](./docs/mkdocs.yml) file and - for the most part - doesn't\nneed to be altered.\n\nIn order to generation a local web server of documentation:\n\n```sh\nmkdocs serve\n```\n\nHowever, it should be noted that live versioned documentation is produced via\nthe appropriate workflow as per the CI/CD section of this document.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started\n\nCreating new re-usable composite actions it as simple as writing a YAML file. However, it's important to keep\na few things in mind:\n- YAML files should denote _what_ the task does simply and plainly\n- The folder structure should denote what the task interacts with\n- Composite actions should be generalised, re-usable, and with a well-defined interface. Generally this means:\n  - Think about how the action(s) you're defining may be used in more than just the specific use-case you're trying to fulfill\n  - Avoid hard-coding, use inputs where possible.\n  - Document your inputs, make them discere where possible via `options`\n  - Document your outputs\n\nA simple truism is thus:\n\n_If I can't tell what the composite action does via its documented inputs and outputs, you haven't\ndocumented it well enough_\n\nThe beauty of such a core library - like any other software - is that if we maintain the same interface, we are free\nto chop and change the underlying implementation(s) as we wish. Whilst maintaining all\nthe other benefits of a [component-based architecture](https://www.mendix.com/blog/what-is-component-based-architecture/).\n\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- USAGE EXAMPLES --\u003e\n## Usage\n\nSee the live [docs](https://sudoblark.github.io/sudoblark.github-actions.library/latest)\nfor more details on usage.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\u003c!-- CONTRIBUTING --\u003e\n## Contributing\n\nPull requests welcome. Fork the repository, create a feature branch, and submit a PR.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\u003c!-- LICENSE --\u003e\n## License\n\nBSD 3-Clause License. See LICENSE.txt for details.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsudoblark%2Fsudoblark.github-actions.library","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsudoblark%2Fsudoblark.github-actions.library","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsudoblark%2Fsudoblark.github-actions.library/lists"}