Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 0 additions & 17 deletions .ghadocs.json

This file was deleted.

91 changes: 0 additions & 91 deletions .github/ghadocs/branding.svg

This file was deleted.

84 changes: 0 additions & 84 deletions .github/ghadocs/social-preview.svg

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/__main-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ jobs:
release:
needs: ci
if: github.event_name != 'schedule'
uses: hoverkraft-tech/ci-github-publish/.github/workflows/release-actions.yml@6d9e5d48da1a80c085e8ed867d680a5e99b28217 # 0.8.0
uses: hoverkraft-tech/ci-github-publish/.github/workflows/release-actions.yml@ebb69cbd25cd8965417ba6933dc3c1327e3e8588 # 0.9.2
with:
update-all: ${{ (github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')) || github.event_name == 'workflow_dispatch' }}
github-app-id: ${{ vars.CI_BOT_APP_ID }}
Expand Down
156 changes: 112 additions & 44 deletions .github/workflows/greetings.md
Original file line number Diff line number Diff line change
@@ -1,88 +1,156 @@
<!-- start branding -->
<!-- end branding -->
<!-- start title -->
<!-- header:start -->

# GitHub Reusable Workflow: Greetings

<!-- end title -->
<!-- start badges -->
<!-- end badges -->
<!-- start description -->
<div align="center">
<img src="../logo.svg" width="60px" align="center" alt="Greetings" />
</div>

---

<!-- header:end -->

<!-- badges:start -->

[![Release](https://img.shields.io/github/v/release/hoverkraft-tech/ci-github-common)](https://github.com/hoverkraft-tech/ci-github-common/releases)
[![License](https://img.shields.io/github/license/hoverkraft-tech/ci-github-common)](http://choosealicense.com/licenses/mit/)
[![Stars](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-common?style=social)](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-common?style=social)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/hoverkraft-tech/ci-github-common/blob/main/CONTRIBUTING.md)

<!-- badges:end -->

<!-- overview:start -->

## Overview

Workflow to greet new contributors.
Mainly using [First Interaction Action](https://github.com/actions/first-interaction), with some opinionated defaults.

- On issue creation, a comment is added to the issue.
- On first contribution, a comment is added to the pull request.

<!-- end description -->
<!-- start contents -->
<!-- end contents -->
### Permissions

## Usage
- **`contents`**: `read`
- **`issues`**: `write`
- **`pull-requests`**: `write`

<!-- start usage -->
<!-- overview:end -->

<!-- usage:start -->

## Usage

```yaml
name: Greetings

on:
issues:
types: [opened]
types:
- opened
pull_request_target:
branches: [main]

branches:
- main
permissions:
contents: read
issues: write
pull-requests: write

jobs:
greetings:
uses: hoverkraft-tech/ci-github-common/.github/workflows/greetings.yml@0.25.0
uses: hoverkraft-tech/ci-github-common/.github/workflows/greetings.yml@d324c777132734fc988c79a74dff3ee0248835fc # 0.25.0
secrets:
# Token for the repository.
# See https://github.com/actions/first-interaction#usage
# Default GITHUB_TOKEN
# See https://github.com/actions/first-interaction#usage.
# Defaults to the GITHUB_TOKEN secret.
github-token: ""

# Optional customizations.
with:
# JSON array of runner(s) to use.
# See https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job.
#
# Default: `["ubuntu-latest"]`
runs-on: '["ubuntu-latest"]'

# Comment to post on an individual's first issue.
# See https://github.com/actions/first-interaction#usage
# Default: "Hi, thank for reporting an issue, we will check it out very soon"
# See https://github.com/actions/first-interaction#usage.
issue-message: ""

# Comment to post on an individual's first pull request.
# See https://github.com/actions/first-interaction#usage
# Default: "Hi, thank you for creating your PR, we will check it out very soon"
# See https://github.com/actions/first-interaction#usage.
pr-message: ""
```

<!-- end usage -->
<!-- usage:end -->

<!-- inputs:start -->

## Inputs

### Workflow Call Inputs

| **Input** | **Description** | **Required** | **Type** | **Default** |
| ------------------- | ---------------------------------------------------------------------------------- | ------------ | ---------- | ------------------- |
| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` |
| | See <https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job>. | | | |
| **`issue-message`** | Comment to post on an individual's first issue. | **false** | **string** | - |
| | See <https://github.com/actions/first-interaction#usage>. | | | |
| **`pr-message`** | Comment to post on an individual's first pull request. | **false** | **string** | - |
| | See <https://github.com/actions/first-interaction#usage>. | | | |

<!-- inputs:end -->

<!-- secrets:start -->

## Secrets

<!-- start secrets -->
| **Secret** | **Description** | **Required** |
| ------------------ | --------------------------------------------------------- | ------------ |
| **`github-token`** | Token for the repository. | **false** |
| | See <https://github.com/actions/first-interaction#usage>. | |
| | Defaults to the GITHUB_TOKEN secret. | |

| **Secret** | **Description** | **Default** | **Required** |
| ----------------------------- | ----------------------------------------------------------------------------------- | ------------------------- | ------------ |
| **<code>github-token</code>** | Token for the repository. See <https://github.com/actions/first-interaction#usage>. | <code>GITHUB_TOKEN</code> | **false** |
<!-- secrets:end -->

<!-- end secrets -->
<!-- outputs:start -->
<!-- outputs:end -->

## Inputs
<!-- examples:start -->
<!-- examples:end -->

<!--
// jscpd:ignore-start
-->

<!-- contributing:start -->

## Contributing

Contributions are welcome! Please see the [contributing guidelines](https://github.com/hoverkraft-tech/ci-github-common/blob/main/CONTRIBUTING.md) for more details.

<!-- contributing:end -->

<!-- security:start -->
<!-- security:end -->

<!-- license:start -->

## License

This project is licensed under the MIT License.

SPDX-License-Identifier: MIT

Copyright © 2025 hoverkraft-tech

For more details, see the [license](http://choosealicense.com/licenses/mit/).

<!-- license:end -->

<!-- start inputs -->
<!-- generated:start -->

| **Input** | **Description** | **Default** | **Type** | **Required** |
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------- | -------- | ------------ |
| **<code>runs-on</code>** | JSON array of runner(s) to use. See <https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job>. | <code>["ubuntu-latest"]</code> | `string` | **false** |
| **<code>issue-message</code>** | Comment to post on an individual's first issue. See <https://github.com/actions/first-interaction#usage>. | <code>Hi, thank for reporting an issue, we will check it out very soon</code> | `string` | **false** |
| **<code>pr-message</code>** | Comment to post on an individual's first pull request. See <https://github.com/actions/first-interaction#usage>. | <code>Hi, thank you for creating your PR, we will check it out very soon</code> | `string` | **false** |
---

<!-- end inputs -->
This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor).

<!-- start outputs -->
<!-- end outputs -->
<!-- start [.github/ghadocs/examples/] -->
<!-- end [.github/ghadocs/examples/] -->
<!-- generated:end -->
<!--
// jscpd:ignore-end
-->
20 changes: 14 additions & 6 deletions .github/workflows/greetings.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Greetings
# ==========================
# Workflow to greet new contributors.
# Mainly using [First Interaction Action](https://github.com/actions/first-interaction), with some opinionated defaults.
#
# - On issue creation, a comment is added to the issue.
# - On first contribution, a comment is added to the pull request.

Expand All @@ -16,21 +15,30 @@ on:
workflow_call:
inputs:
runs-on:
description: "JSON array of runner(s) to use. See <https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job>."
description: |
JSON array of runner(s) to use.
See https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job.
type: string
default: '["ubuntu-latest"]'
required: false
issue-message:
description: "Comment to post on an individual's first issue. See <https://github.com/actions/first-interaction#usage>."
description: |
Comment to post on an individual's first issue.
See https://github.com/actions/first-interaction#usage.
type: string
required: false
pr-message:
description: "Comment to post on an individual's first pull request. See <https://github.com/actions/first-interaction#usage>."
description: |
Comment to post on an individual's first pull request.
See https://github.com/actions/first-interaction#usage.
type: string
required: false
secrets:
github-token:
description: "Token for the repository. See <https://github.com/actions/first-interaction#usage>."
description: |
Token for the repository.
See https://github.com/actions/first-interaction#usage.
Defaults to the GITHUB_TOKEN secret.

permissions:
contents: read
Expand Down
Loading
Loading