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

Add license-checker action that fails when any backported file contains BUSL header #18485

Merged
merged 3 commits into from
Aug 16, 2023
Merged

Add license-checker action that fails when any backported file contains BUSL header #18485

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
29a0562
Add license-checker action that fails when any backported file contai…
nathancoleman Aug 16, 2023
8e083db
Quote echoed variable to retain line breaks
nathancoleman Aug 16, 2023
afc0ca9
Add ticket to reference for more details
nathancoleman Aug 16, 2023
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
16 changes: 16 additions & 0 deletions .github/scripts/license_checker.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#!/bin/bash
# Copyright (c) HashiCorp, Inc.
# SPDX-License-Identifier: BUSL-1.1


busl_files=$(grep -r 'SPDX-License-Identifier: BUSL' --exclude=./.github/scripts/license_checker.sh .)

# If we do not find a file in .changelog/, we fail the check
if [ -n "$busl_files" ]; then
echo "Found BUSL occurrences in the PR branch!"
nathancoleman marked this conversation as resolved.
Show resolved Hide resolved
echo -e $busl_files
exit 1
else
echo "Did not find any occurrences of BUSL in the PR branch"
exit 0
fi
27 changes: 27 additions & 0 deletions .github/workflows/license-checker.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Copyright (c) HashiCorp, Inc.
# SPDX-License-Identifier: MPL-2.0

# This workflow checks that the BUSL license is not mentioned anywhere in
# a PR targeting a release that should maintain the MPL-2.0 license.
name: License Checker

on:
pull_request:
types: [opened]
branches:
- release/1.14.*
- release/1.15.*
- release/1.16.*
Comment on lines +11 to +14
Copy link
Member Author

@nathancoleman nathancoleman Aug 16, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

I added versions I expect people to be backporting into these days. We can go back further if people think it's warranted.

I also wanted to make sure not to run on release/1.17.x once it exists since code in that release will be under BUSL.


jobs:
# checks that the diff does not contain any reference to
# the BUSL license and thus retains the MPL-2.0 license
license-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3
with:
ref: ${{ github.event.pull_request.head.sha }}
fetch-depth: 0 # by default the checkout action doesn't checkout all branches
- name: Check for BUSL text in diff
run: ./.github/scripts/license_checker.sh