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.

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

Remove ``` from LICENSE.md #877

Merged
merged 2 commits into from Jul 21, 2020
Merged

Remove ``` from LICENSE.md #877

merged 2 commits into from Jul 21, 2020

Conversation

@mikrobi
Copy link
Contributor

@mikrobi mikrobi commented Jul 16, 2020

The leading ``` make it hard for licensed to parse the license. Can we drop them?

The leading ``` makes it hard for [licensed](https://github.com/github/licensed/) to parse the license. Can we drop them?
@adamruzicka
Copy link
Collaborator

@adamruzicka adamruzicka commented Jul 16, 2020

To expand on this, does the license need to be a markdown file?

@LikeLakers2
Copy link
Contributor

@LikeLakers2 LikeLakers2 commented Jul 16, 2020

If the intent is to have it detected as the MIT License, I believe there is more you'd have to fix with the license file. While it does include the MIT license text, it also includes a link and extra text on the copyright line, which may also be part of why licensed is confused. Additionally, if you look at the fork's repository page, GitHub still shows a generic "View License" link -- suggesting that licensed is still confused about which license the repository is under. Although it's possible that licensed only checks against the master branch, as the fork's master branch still has the backticks.

@adamruzicka I've seen some repositories that will use no extension, some that will use .MD, and a couple that even use .TXT. As far as I'm aware, the file extension does not matter -- I believe it only matters that the filename is the case-insensitive name LICENSE. Once that is met, GitHub will have licensed parse the file and see if it matches a known license.

@mikrobi
Copy link
Contributor Author

@mikrobi mikrobi commented Jul 16, 2020

I assume licensed reads the license from the gemspec file, which also contains a reference to the LICENSE.md file. I don't think the license is actually parsed LICENSE.md however the result cached by licensed looked weird:

summary: Modern concurrency tools for Ruby. Inspired by Erlang, Clojure, Scala, Haskell,
  F#, C#, Java, and classic concurrency patterns.
homepage: http://www.concurrent-ruby.com
license: other
licenses:
- sources: LICENSE.md
  text: "```\nCopyright (c) Jerry D'Antonio -- released under the MIT license.\n\nhttp://www.opensource.org/licenses/mit-license.php
    \ \n\nPermission is hereby granted, free of charge, to any person obtaining a
    copy  \nof this software and associated documentation files (the \"Software\"),
    to deal  \nin the Software without restriction, including without limitation the
    rights  \nto use, copy, modify, merge, publish, distribute, sublicense, and/or
    sell  \ncopies of the Software, and to permit persons to whom the Software is
    \ \nfurnished to do so, subject to the following conditions:  \n \nThe above copyright
    notice and this permission notice shall be included in  \nall copies or substantial
    portions of the Software.  \n \nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY
    OF ANY KIND, EXPRESS OR  \nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
    OF MERCHANTABILITY,  \nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
    NO EVENT SHALL THE  \nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
    OR OTHER  \nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM,  \nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
    IN  \nTHE SOFTWARE. \n```\n"
notices: []
@pitr-ch pitr-ch self-requested a review Jul 20, 2020
@pitr-ch pitr-ch added the bug label Jul 20, 2020
- make sure it works in YARD
@pitr-ch
Copy link
Member

@pitr-ch pitr-ch commented Jul 20, 2020

I've changed it to txt file and made sure it works in YARD. Will it work for you like this?

@mikrobi
Copy link
Contributor Author

@mikrobi mikrobi commented Jul 21, 2020

@pitr-ch that looks good to me!

@pitr-ch pitr-ch merged commit 7626ed5 into ruby-concurrency:master Jul 21, 2020
2 checks passed
2 checks passed
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants
You can’t perform that action at this time.