Skip to content

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

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

HosurSharanamma wants to merge 6 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

@HosurSharanamma
HosurSharanamma force-pushed the feat/add-first-interaction-workflow branch from 7e54798 to c872e62 Compare May 27, 2026 21:09

@alexmohr alexmohr left a 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.

Thank for your pull request :)

Comment thread .github/workflows/first-interaction.yml Outdated
alexmohr
alexmohr previously approved these changes May 29, 2026

@alexmohr alexmohr left a 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.

Awesome, thank you!

Comment thread .github/workflows/first-interaction.yml Outdated
Comment thread .github/workflows/first-interaction.yml
Comment thread .github/workflows/first-interaction.yml
Comment thread .github/workflows/first-interaction.yml Outdated
@@ -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.

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.

#56 <-- follow up to fix this, as this is out of scope here.

Comment thread .github/workflows/first-interaction.yml Outdated
Comment thread .github/workflows/first-interaction.yml Outdated
- 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.

@lh-sag lh-sag May 29, 2026 •

Copy link
Copy Markdown

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 🙈

@lh-sag lh-sag May 29, 2026 •

Copy link
Copy Markdown

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.

@HosurSharanamma
HosurSharanamma force-pushed the feat/add-first-interaction-workflow branch from f06fdd6 to 4c0fb8c Compare June 10, 2026 07:52
@HosurSharanamma
HosurSharanamma force-pushed the feat/add-first-interaction-workflow branch from 4c0fb8c to 95a029e Compare June 10, 2026 08:01
@HosurSharanamma

Copy link
Copy Markdown
Contributor Author

Addressed all feedback:

Fixed copyright year from 2025 → 2026
Fixed workflow name from CI Checks → First Interaction (was conflicting with checks.yml)
Pinned runner from ubuntu-latest → ubuntu-24.04
@lh-sag @alexmohr for your review

Comment thread .github/workflows/coverage.yml Outdated
Comment thread .github/workflows/coverage.yml Outdated
Comment thread .github/workflows/first-interaction.yml Outdated
@HosurSharanamma
HosurSharanamma force-pushed the feat/add-first-interaction-workflow branch from 7d15c78 to 4db558c Compare June 16, 2026 10:00
Comment thread .github/workflows/coverage.yml Outdated
# pull-requests: write is required when post-pr-comment input is true.
# The caller workflow must grant this permission explicitly.
pull-requests: write
# The caller workflow must grant this permission explicitly.

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.

todo: please fix the indentation here.

Suggested change
# The caller workflow must grant this permission explicitly.
# The caller workflow must grant this permission explicitly.

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.

@HosurSharanamma please do not resolve my review comments. I will resolve them myself when I re-reviewed. This one was resolved, but is not fixed yet. The indentation is still wrong.

if: >-
inputs.post-pr-comment && github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository
uses: actions/github-script@v9
if: ${{ inputs.post-pr-comment && github.event_name == 'pull_request' }}

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: these changes seem unrelated to the 'first interaction workflow' are these on purpose?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks for hinting , those changes to coverage.yml were unrelate. I've removed them in the latest push.

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 still see the changes in the diff, github fooling me or does this still need a push?

@HosurSharanamma
HosurSharanamma force-pushed the feat/add-first-interaction-workflow branch 3 times, most recently from 96d7b33 to 4db558c Compare June 16, 2026 20:21
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](https://github.com/eclipse-opensovd/opensovd/blob/main/CONTRIBUTING.md)

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
Please make sure you've reviewed our [contribution guidelines](https://github.com/eclipse-opensovd/opensovd/blob/main/CONTRIBUTING.md)
Please make sure you've reviewed our [contribution guidelines](https://github.com/{{ github.repository_owner }}/${{ github.event.repository.name }}/blob/main/CONTRIBUTING.md)

@alexmohr would this work for you? Given that you add this file to cda.

@HosurSharanamma I am not sure whether this works. So feel free to experiment.

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.

If that works that would be awesome.

Signed-off-by: sharanamma hosur <h.sharanamma@gmail.com>
Signed-off-by: sharanamma hosur <h.sharanamma@gmail.com>
Signed-off-by: HosurSharanamma <h.sharanamma@gmail.com>
Signed-off-by: HosurSharanamma <h.sharanamma@gmail.com>
@HosurSharanamma
HosurSharanamma force-pushed the feat/add-first-interaction-workflow branch from 718422d to 868a998 Compare July 29, 2026 08:36
@HosurSharanamma
HosurSharanamma requested a review from alexmohr July 29, 2026 08:37
Comment thread .github/workflows/coverage.yml Outdated
# pull-requests: write is required when post-pr-comment input is true.
# The caller workflow must grant this permission explicitly.
pull-requests: write
# The caller workflow must grant this permission explicitly.

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.

@HosurSharanamma please do not resolve my review comments. I will resolve them myself when I re-reviewed. This one was resolved, but is not fixed yet. The indentation is still wrong.

if: >-
inputs.post-pr-comment && github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository
uses: actions/github-script@v9
if: ${{ inputs.post-pr-comment && github.event_name == 'pull_request' }}

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 still see the changes in the diff, github fooling me or does this still need a push?

coverage.yml was accidentally carrying stale/reverted content
(missing pull-requests: write permission, older github-script
version, bad comment indentation) unrelated to the first-interaction
workflow. Restore it to match main exactly.
Apply the same dynamic link pattern already used in the issue-message
to the pr-message, so forks/other orgs point to their own
CONTRIBUTING.md instead of eclipse-opensovd/opensovd.
@HosurSharanamma

Copy link
Copy Markdown
Contributor Author

coverage.yml is reverted back to match main exactly — the unrelated/stale content (missing pull-requests: write, wrong indentation, older github-script version) is gone. This PR now only touches first-interaction.yml.
The pr-message's CONTRIBUTING.md link is now dynamic (${{ github.repository_owner }}/${{ github.event.repository.name }}), matching the issue-message link fix from earlier, per @lh-sag's comment.

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