Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DAOS-15677 cq: add copyright GHA #15552

Merged
merged 7 commits into from
Dec 11, 2024
Merged

DAOS-15677 cq: add copyright GHA #15552

merged 7 commits into from
Dec 11, 2024

Conversation

daltonbohning
Copy link
Contributor

Add GHA to check for copyright update.
Move core logic from update-copyright githook into check_update_copyright.sh so the logic is shared between the githook and GHA.

Skip-build: true

Required-githooks: true

Before requesting gatekeeper:

  • Two review approvals and any prior change requests have been resolved.
  • Testing is complete and all tests passed or there is a reason documented in the PR why it should be force landed and forced-landing tag is set.
  • Features: (or Test-tag*) commit pragma was used or there is a reason documented that there are no appropriate tags for this PR.
  • Commit messages follows the guidelines outlined here.
  • Any tests skipped by the ticket being addressed have been run and passed in the PR.

Gatekeeper:

  • You are the appropriate gatekeeper to be landing the patch.
  • The PR has 2 reviews by people familiar with the code, including appropriate owners.
  • Githooks were used. If not, request that user install them and check copyright dates.
  • Checkpatch issues are resolved. Pay particular attention to ones that will show up on future PRs.
  • All builds have passed. Check non-required builds for any new compiler warnings.
  • Sufficient testing is done. Check feature pragmas and test tags and that tests skipped for the ticket are run and now pass with the changes.
  • If applicable, the PR has addressed any potential version compatibility issues.
  • Check the target branch. If it is master branch, should the PR go to a feature branch? If it is a release branch, does it have merge approval in the JIRA ticket.
  • Extra checks if forced landing is requested
    • Review comments are sufficiently resolved, particularly by prior reviewers that requested changes.
    • No new NLT or valgrind warnings. Check the classic view.
    • Quick-build or Quick-functional is not used.
  • Fix the commit message upon landing. Check the standard here. Edit it to create a single commit. If necessary, ask submitter for a new summary.

@daltonbohning daltonbohning self-assigned this Dec 3, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Dec 3, 2024

Ticket title is 'add copyright GHA and remove required-githooks watermark'
Status is 'In Progress'
https://daosio.atlassian.net/browse/DAOS-15677

@daltonbohning daltonbohning force-pushed the dbohning/daos-15677 branch 8 times, most recently from a33fbbf to 757a388 Compare December 3, 2024 18:59
@daltonbohning
DAOS-15677 cq: add copyright GHA
585384d 
Add GHA to check for copyright update.
Move core logic from update-copyright githook into
check_update_copyright.sh so the logic is shared between the githook and
GHA.

Skip-build: true

Required-githooks: true

Signed-off-by: Dalton Bohning <[email protected]>
@daltonbohning
intentionally do not update
4d45740 
Skip-build: true

Signed-off-by: Dalton Bohning <[email protected]>
@daltonbohning
more debug
0f9db64 
Skip-build: true

Signed-off-by: Dalton Bohning <[email protected]>
@daltonbohning
use merge-base
f7ea6bd 
Skip-build: true

Required-githooks: true

Signed-off-by: Dalton Bohning <[email protected]>
@daltonbohning
add lineno
4112206 
Skip-build: true

Signed-off-by: Dalton Bohning <[email protected]>
@daltonbohning
Copy link
Contributor Author

I need to remove DEBUG and the dummy change, but I left it for now so we can see how it works.

daltonbohning
daltonbohning commented Dec 3, 2024
View reviewed changes
src/client/dfuse/pil4dfs/hook_int.h Outdated
Comment on lines 8 to 9

/* dummy change */
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Notice if you view this file in the Files changed tab, the annotation for the copyright is inline

Copy link
Contributor

Choose a reason for hiding this comment

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

Looks good.

daltonbohning
daltonbohning commented Dec 3, 2024
View reviewed changes
utils/cq/check_update_copyright.sh
Comment on lines +81 to +83
if [[ -z $y1 ]] ; then
# Print warning but don't error on non-existent copyright
echo " Copyright Information not found in: $file"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's possible to propagate warnings to GHA but I'm not sure how many files would be flagged here

daltonbohning
daltonbohning commented Dec 3, 2024
View reviewed changes
.github/workflows/linting.yml
@@ -197,6 +197,20 @@ jobs:
- name: Run check
run: yamllint --format github .

copyright:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Plan to make the GHA required after we're sure it's stable

@daltonbohning daltonbohning requested a review from phender December 3, 2024 20:52
brianjmurrell
brianjmurrell requested changes Dec 4, 2024
View reviewed changes
Copy link
Contributor

@brianjmurrell brianjmurrell left a comment

Choose a reason for hiding this comment

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

Looks good. Please re-request review once you have cleaned it up.

utils/githooks/pre-commit.d/30-Jenkinsfile.sh Outdated
Comment on lines 26 to 29
CURL_OPTS="$CURL_PROXY $CURL_VERBOSE -s"
URL="https://$HOST/pipeline-model-converter/validate"
# shellcheck disable=SC2086
if ! output=$(curl $CURL_OPTS -s -X POST -F "jenkinsfile=<${1:-Jenkinsfile}" "$URL"); then
Copy link
Contributor

Choose a reason for hiding this comment

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

SC2086 is usually pretty easy to resolve:

Suggested change
CURL_OPTS="$CURL_PROXY $CURL_VERBOSE -s"
URL="https://$HOST/pipeline-model-converter/validate"
# shellcheck disable=SC2086
if ! output=$(curl $CURL_OPTS -s -X POST -F "jenkinsfile=<${1:-Jenkinsfile}" "$URL"); then
CURL_OPTS=($CURL_PROXY $CURL_VERBOSE -s)
URL="https://$HOST/pipeline-model-converter/validate"
if ! output=$(curl "${CURL_OPTS[@]}" -s -X POST -F "jenkinsfile=<${1:-Jenkinsfile}" "$URL"); then

Clearly I should have done that in the first place.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Actually, no. It doesn't like that either
https://github.com/daos-stack/daos/actions/runs/12164183236/job/33925207435?pr=15552

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Pushed with more quotes

@daltonbohning
cleanup
5609bf3 
Skip-build: true

Required-githooks: true

Signed-off-by: Dalton Bohning <[email protected]>
@daltonbohning
fix fix
e8678b5 
Skip-build: true

Required-githooks: true

Signed-off-by: Dalton Bohning <[email protected]>
@daltonbohning daltonbohning marked this pull request as ready for review December 4, 2024 20:55
@daltonbohning daltonbohning requested review from a team and removed request for ashleypittman December 10, 2024 15:32
@daltonbohning daltonbohning added the forced-landing The PR has known failures or has intentionally reduced testing, but should still be landed. label Dec 10, 2024
@daltonbohning daltonbohning merged commit 30065cb into master Dec 11, 2024
37 of 39 checks passed
@daltonbohning daltonbohning deleted the dbohning/daos-15677 branch December 11, 2024 19:24
daltonbohning added a commit that referenced this pull request Dec 20, 2024
@daltonbohning
DAOS-15677 cq: add copyright GHA and remove required-githooks (#15552)
d3b2004 
Add GHA to check for copyright update.
Move core logic from update-copyright githook into
check_update_copyright.sh so the logic is shared between the githook and
GHA.

Remove required-githooks watermark since it did not work in all scenarios and the
GHA checks are more secure than client-side githooks.

Combination of #15552, #15596, #15636, #15639

Skip-build: true

Signed-off-by: Dalton Bohning <[email protected]>
daltonbohning added a commit that referenced this pull request Dec 20, 2024
@daltonbohning
DAOS-15677 cq: add copyright GHA and remove required-githooks (#15552)
312236e 
Add GHA to check for copyright update.
Move core logic from update-copyright githook into
check_update_copyright.sh so the logic is shared between the githook and
GHA.

Remove required-githooks watermark since it did not work in all scenarios and the
GHA checks are more secure than client-side githooks.

Combination of #15552, #15596, #15636, #15639

Skip-build: true

Signed-off-by: Dalton Bohning <[email protected]>
@daltonbohning daltonbohning mentioned this pull request Dec 20, 2024
Open
18 tasks
daltonbohning added a commit that referenced this pull request Dec 20, 2024
@daltonbohning
DAOS-15677 cq: add copyright GHA and remove required-githooks (#15552)
d6b7d17 
Add GHA to check for copyright update.
Move core logic from update-copyright githook into
check_update_copyright.sh so the logic is shared between the githook and
GHA.

Remove required-githooks watermark since it did not work in all scenarios and the
GHA checks are more secure than client-side githooks.

Combination of #15552, #15596, #15636, #15639

Skip-build: true

Signed-off-by: Dalton Bohning <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@phender phender phender approved these changes

@brianjmurrell brianjmurrell brianjmurrell approved these changes

@jolivier23 jolivier23 Awaiting requested review from jolivier23

Assignees

@daltonbohning daltonbohning

Labels
forced-landing The PR has known failures or has intentionally reduced testing, but should still be landed.
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@daltonbohning @brianjmurrell @phender