Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eliashaeussler/.github

:octocat: My personal GitHub configuration
https://github.com/eliashaeussler/.github

actions configuration funding github

Last synced: about 1 month ago
JSON representation

:octocat: My personal GitHub configuration

Awesome Lists containing this project

README

        

# GitHub configuration

[![CGL](https://img.shields.io/github/actions/workflow/status/eliashaeussler/.github/cgl.yaml?label=cgl&logo=github)](https://github.com/eliashaeussler/.github/actions/workflows/cgl.yaml)

This repository contains my personal GitHub configuration for use in my
personal projects. It is not meant to be used anywhere else. I won't provide
support and don't accept pull requests for this repo.

## 🔈 GitHub Actions

### `eliashaeussler/.github/actions/github/check-pr`

This action checks if any open pull request exists with the current branch as
[head ref][1].

#### Reference

[`actions/github/check-pr/action.yml`](actions/github/check-pr/action.yml)

#### Example

```yaml
jobs:
check-pr:
runs-on: ubuntu-latest
outputs:
pr-exists: ${{ steps.check.outputs.pr-exists }}
steps:
- name: Check if PR exists
id: check
uses: eliashaeussler/.github/actions/github/[email protected]
```

#### Inputs

| Name | Required | Description | Default value |
|--------------|----------|-------------------------------------------|----------------------------|
| `repository` | ✅ | GitHub repository to check for an open PR | `${{ github.repository }}` |
| `branch` | ✅ | Branch name to check for an open PR | `${{ github.ref_name }}` |
| `token` | ✅ | GitHub token used for authentication | `${{ github.token }}` |

#### Outputs

| Name | Description |
|-------------|--------------------------------------------|
| `pr-exists` | Flag to indicate whether an open PR exists |
| `pr-url` | URL to an open PR if any exists |

### `eliashaeussler/.github/actions/github/trigger-workflow`

This action triggers a specific GitHub workflow that supports the
[`workflow_dispatch`][2] event.

#### Reference

[`actions/github/trigger-workflow/action.yml`](actions/github/trigger-workflow/action.yml)

#### Example

```yaml
jobs:
trigger-cgl:
runs-on: ubuntu-latest
steps:
- name: Trigger CGL workflow
uses: eliashaeussler/.github/actions/github/[email protected]
with:
workflow: cgl.yaml
```

#### Inputs

| Name | Required | Description | Default value |
|--------------|----------|---------------------------------------------------------------|----------------------------|
| `repository` | ✅ | Hub repository of the workflow to trigger | `${{ github.repository }}` |
| `workflow` | ✅ | Name, ID or file name of the workflow to trigger | – |
| `branch` | ✅ | Branch for which to trigger the workflow | `${{ github.ref_name }}` |
| `inputs` | – | Optional inputs to pass to the workflow (JSON-encoded string) | `{}` |
| `token` | ✅ | GitHub token used for authentication | `${{ github.token }}` |

#### Outputs

*None*

## ⭐ License

This project is licensed under [GNU General Public License 3.0 (or later)](LICENSE).

[1]: https://docs.github.com/en/actions/learn-github-actions/contexts#github-context
[2]: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch