feat: add first-interaction workflow for new contributors#42
feat: add first-interaction workflow for new contributors#42HosurSharanamma wants to merge 2 commits into
Conversation
Signed-off-by: sharanamma hosur <h.sharanamma@gmail.com>
7e54798 to
c872e62
Compare
alexmohr
left a comment
There was a problem hiding this comment.
Thank for your pull request :)
| issue-message: | | ||
| Welcome, and thanks for opening your first issue! | ||
|
|
||
| Please make sure you've reviewed our [contribution guidelines](../../blob/main/CONTRIBUTING.md) |
There was a problem hiding this comment.
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>
|
|
||
| jobs: | ||
| first-interaction: | ||
| runs-on: ubuntu-latest |
There was a problem hiding this comment.
Please pin to a specific ubuntu version (most recent).
|
|
||
| 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: |
There was a problem hiding this comment.
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) | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
I'll clarify with the compliance people if this is necessary for some legal reasons, I'll report back
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
| 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. |
There was a problem hiding this comment.
Is there a way to point to the repositories CONTRIBUTING.md file?
Usually the projects have some specifics.
There was a problem hiding this comment.
do they? In CDA we're missing the file entirely, but that could be an oversight on our end too 🙈
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
Summary
Adds a
first-interaction.ymlworkflow that automatically posts awelcome 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-corerepository already has thisworkflow; this change brings
cicd-workflowsto parity.Changes
.github/workflows/first-interaction.ymlusingactions/first-interaction@v1follow the contribution guidelines
CI checks and the Eclipse DCO sign-off requirement
Testing
uv run https://raw.githubusercontent.com/eclipse-opensovd/cicd-workflows/main/run_checks.pylocally — all checks passedcheck yamlandyamlfmthooksRelates to #38