Add CI workflow to check the license file #10
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MatteoPologruto
added
type: enhancement
|
Actually, the LICENSE.txt is the union of I prefer |
Whenever one of the recognized license file names are modified in the repository, the workflow runs to check whether the license can be recognized and whether it is of the expected type. GitHub has a useful automated license detection system that determines the license type used by a repository, and surfaces that information in the repository home page, the search web interface, and the GitHub API. This license detection system requires that the license be defined by a dedicated file with one of several standardized filenames and paths. GitHub's license detection system uses the popular licensee tool, so this file also serves to define the license type for any other usages of licensee, as well as to human readers of the file. For this reason, and to ensure it remains a valid legal instrument, it's important that there be no non-standard modifications to the license file or collisions with other supported license files. This workflow ensures that any changes which would change the license type or which license file is used by the detection are caught automatically.
MatteoPologruto
force-pushed
the
add-check-license
branch
from
62c786b to
8fb7c81
Compare
umbynos
approved these changes
Mar 27, 2023
cmaglie
reviewed
Mar 28, 2023
Comment on lines
-1
to
-29
| /* | ||
| * This file is part of go-win32-utils. | ||
| * | ||
| * Copyright 2018-2023 ARDUINO SA (http://www.arduino.cc/) | ||
| * | ||
| * go-win32-utils is free software; you can redistribute it and/or modify | ||
| * it under the terms of the GNU General Public License as published by | ||
| * the Free Software Foundation; either version 2 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License | ||
| * along with this program; if not, write to the Free Software | ||
| * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | ||
| * | ||
| * As a special exception, you may use this file as part of a free software | ||
| * library without restriction. Specifically, if other files instantiate | ||
| * templates or use macros or inline functions from this file, or you compile | ||
| * this file and link it with other files to produce an executable, this | ||
| * file does not by itself cause the resulting executable to be covered by | ||
| * the GNU General Public License. This exception does not however | ||
| * invalidate any other reasons why the executable file might be covered by | ||
| * the GNU General Public License. | ||
| */ | ||
|
|
There was a problem hiding this comment.
This change removes the license header from the files.
I think that there must be a license header like:
//
// Copyright 2018-2023 ARDUINO SA. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
//
cmaglie
reviewed
Mar 28, 2023
Comment on lines
-30
to
-31
| // Package win32 is a collection of useful bindings to Win32 API that are not available in the standard | ||
| // golang windows/syscall package. |
There was a problem hiding this comment.
This is the package description, it should not be removed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Whenever one of the recognized license file names are modified in the repository, the workflow runs licensee to check whether the license can be recognized and whether it is of the expected type.
GitHub has a useful automated license detection system that determines the license type used by a repository, and surfaces that information in the repository home page, the search web interface, and the GitHub API. This license detection system requires that the license be defined by a dedicated file with one of several standardized filenames and paths.
GitHub's license detection system uses the popular licensee tool, so this file also serves to define the license type for any other usages of licensee, as well as to human readers of the file.
For this reason, and to ensure it remains a valid legal instrument, it's important that there be no non-standard modifications to the license file or collisions with other supported license files. This workflow ensures that any changes which would change the license type or which license file is used by the detection are caught automatically.
The workflow is currently failing because the detected license type is
NOASSERTIONwhen it should beGPL-2.0. I ranlicensee detectlocally, this is the result:This is the result of
licensee diff --license gpl-2.0:Is this happening because the license is outdated? Should we bump it to
GPL-3.0?