Skip to content

feat: add first-interaction workflow for new contributors#42

Open
HosurSharanamma wants to merge 2 commits into
eclipse-opensovd:mainfrom
HosurSharanamma:feat/add-first-interaction-workflow
Open

feat: add first-interaction workflow for new contributors#42
HosurSharanamma wants to merge 2 commits into
eclipse-opensovd:mainfrom
HosurSharanamma:feat/add-first-interaction-workflow

Conversation

@HosurSharanamma
Copy link
Copy Markdown
Contributor

Summary

Adds a first-interaction.yml workflow that automatically posts a
welcome comment when someone opens their first issue or pull request
in the repository.

Motivation

Identified as a gap in issue #38 (CI parity analysis: opensovd-core
vs cicd-workflows). The opensovd-core repository already has this
workflow; this change brings cicd-workflows to parity.

Changes

  • Added .github/workflows/first-interaction.yml using
    actions/first-interaction@v1
  • Posts a welcome message on first issues reminding contributors to
    follow the contribution guidelines
  • Posts a welcome message on first PRs reminding contributors about
    CI checks and the Eclipse DCO sign-off requirement

Testing

  • Ran uv run https://raw.githubusercontent.com/eclipse-opensovd/cicd-workflows/main/run_checks.py locally — all checks passed
  • Workflow syntax validated by check yaml and yamlfmt hooks

Relates to #38

Signed-off-by: sharanamma hosur <h.sharanamma@gmail.com>
@HosurSharanamma HosurSharanamma force-pushed the feat/add-first-interaction-workflow branch from 7e54798 to c872e62 Compare May 27, 2026 21:09
Copy link
Copy Markdown
Contributor

@alexmohr alexmohr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank for your pull request :)

Comment thread .github/workflows/first-interaction.yml Outdated
issue-message: |
Welcome, and thanks for opening your first issue!

Please make sure you've reviewed our [contribution guidelines](../../blob/main/CONTRIBUTING.md)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question: instead of using a relative link, could we link to the contributing of the main repo https://github.com/eclipse-opensovd/opensovd/blob/main/CONTRIBUTING.md, this should be the always up to date version.
Same in line 43.

Signed-off-by: sharanamma hosur <h.sharanamma@gmail.com>
Copy link
Copy Markdown
Contributor

@alexmohr alexmohr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, thank you!


jobs:
first-interaction:
runs-on: ubuntu-latest
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please pin to a specific ubuntu version (most recent).

Comment thread .github/workflows/first-interaction.yml

A few things to keep in mind:
- Make sure CI checks pass before requesting a review.
- Eclipse projects require a **DCO sign-off** on every commit:
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMHO this is not needed anymore so we can drop this: https://www.eclipse.org/lists/eclipse.org-committers/msg01291.html
But you can add a remark about the ECA.

If you dont mind and this is once merged you can replace opensovd-core workflow action.

@@ -0,0 +1,45 @@
# SPDX-License-Identifier: Apache-2.0
# SPDX-FileCopyrightText: 2025 The Contributors to Eclipse OpenSOVD (see CONTRIBUTORS)
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use 2026.

The trailing (see CONTRIBUTORS) is not common, I have not seen it in SCORE either. @alexmohr what was the intend of this remark and file. Could we simply remove it, at least he appearance in the comment.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right now it is necessary to keep (see CONTRIBUTORS) otherwise the pipeline complains that the copyright header does not match. Year can be adjusted.
I'm not sure why we're using the copyright header with CONTRIBUTORS iirc @floroks was deeper involved in the discussion.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll clarify with the compliance people if this is necessary for some legal reasons, I'll report back

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So feedback from our MBTI compliance people is pretty much what @lh-sag suggested :)

We can drop the (see Contributors) but keeping the block about notice etc (which no one discussed to remove here, just mentioning it for clarity) should be kept, because an Apache 2.0 licensed software must be shipped with a notice file if one is contained and mentioning it in the copyright makes it harder to miss the notice file (in theory at least).

Imho would make sense to do this in a follow up though.

# terms of the Apache License Version 2.0 which is available at
# https://www.apache.org/licenses/LICENSE-2.0

name: CI Checks
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
name: CI Checks
name: first-interaction

- Make sure CI checks pass before requesting a review.
- Eclipse projects require a **DCO sign-off** on every commit:
use `git commit -s` or add `Signed-off-by: Your Name <email>` manually.
- See [CONTRIBUTING.md](https://github.com/eclipse-opensovd/opensovd/blob/main/CONTRIBUTING.md) for details.
Copy link
Copy Markdown

@lh-sag lh-sag May 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a way to point to the repositories CONTRIBUTING.md file?

Usually the projects have some specifics.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do they? In CDA we're missing the file entirely, but that could be an oversight on our end too 🙈

Copy link
Copy Markdown

@lh-sag lh-sag May 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can make the url overwritable then. If not specified pick the generic one as a fallback.

At least to me it would be odd getting such comment pointing to opensovd but I want the contribution guide from opensovd-cda/-core

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probably would be best if each project just ships the file, if it's a carbon copy so be it, but it's also easier for newcomers to find it then. I'll make sure to fix this on cda side.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants