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

Force usage of included LICENSE file #5055

Merged
merged 35 commits into from
May 6, 2022
Merged

Force usage of included LICENSE file #5055

merged 35 commits into from
May 6, 2022

Conversation

Pandapip1
Copy link
Member

@Pandapip1 Pandapip1 commented Apr 29, 2022

When opening a pull request to submit a new EIP, please use the suggested template: https://github.com/ethereum/EIPs/blob/master/eip-template.md

We have a GitHub bot that automatically merges some PRs. It will merge yours immediately if certain criteria are met:

  • The PR edits only existing draft PRs.
  • The build passes.
  • Your GitHub username or email address is listed in the 'author' header of all affected PRs, inside .
  • If matching on email address, the email address is the one publicly listed on your GitHub profile.

Fixes #5031

@eth-bot
Copy link
Collaborator

eth-bot commented Apr 29, 2022

A critical and unhandled exception has occurred:
Message: api rate limit exceeded for user id 85952233.
Data: (there is no data for this error)(cc @alita-moore, @mryalamanchi)

@Pandapip1 Pandapip1 changed the title Include LICENCE in the Jekyll build Include LICENCE in the Jekyll build and use it in EIPs Apr 29, 2022
@Pandapip1
Copy link
Member Author

This changes some text on EIP-1 to make sure the old link is no longer used. CC @lightclient @SamWilsn @MicahZoltu

@Pandapip1 Pandapip1 changed the title Include LICENCE in the Jekyll build and use it in EIPs Include LICENCE, use it in EIPs, and mandate the new LICENCE file in EIP-1 Apr 29, 2022
@Pandapip1 Pandapip1 changed the title Include LICENCE, use it in EIPs, and mandate the new LICENCE file in EIP-1 Include CC0 in built EIP website, and mandate its usage in EIP-1 Apr 29, 2022
@Pandapip1
Copy link
Member Author

I'll have https://pandapip1.github.io/EIPs/ point to the build of this PR for now.

Relevant links:

https://pandapip1.github.io/EIPs/CC0
https://pandapip1.github.io/EIPs/EIPS/EIP-1

@MicahZoltu
Copy link
Contributor

When viewing the page in GitHub, the link to ../CC0 won't work I believe. Can we link to ../LICENSE instead?

Regarding changing from https://creativecommons.org/publicdomain/zero/1.0/ to a relative link, I'm conflicted. On the one hand, I do generally like to avoid external links. On the other hand, I think there is value in linking externally here because it gives people confidence that the license they are agreeing to is the standard CC0 license and not something that was modified by us.

EIPS/eip-999.md Outdated Show resolved Hide resolved
_config.yml Outdated Show resolved Hide resolved
EIPS/eip-2771.md Outdated Show resolved Hide resolved
@Pandapip1
Copy link
Member Author

Pandapip1 commented May 3, 2022

So apparently, it is possible to get Jekyll to render the file without the preamble. However, the .md will have to stay. I am now confident that the tooling will NOT break, as licensee checks for any files with the word "license" in it.

@Pandapip1 Pandapip1 requested a review from MicahZoltu May 3, 2022 20:56
EIPS/eip-1010.md Outdated Show resolved Hide resolved
EIPS/eip-1123.md Outdated Show resolved Hide resolved
EIPS/eip-3068.md Outdated Show resolved Hide resolved
EIPS/eip-777.md Outdated Show resolved Hide resolved
EIPS/eip-820.md Outdated Show resolved Hide resolved
EIPS/eip-820.md Outdated Show resolved Hide resolved
EIPS/eip-820.md Outdated Show resolved Hide resolved
Copy link
Contributor

@MicahZoltu MicahZoltu left a comment

Choose a reason for hiding this comment

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

I'm good with this and I didn't hear anyone oppose it in the most recent call. I think the bot will still merge with a single reviewer, so I'm using the lack of 👎 in the call as a proxy for additional editor reviews.

@MicahZoltu
Copy link
Contributor

Oh, actually I think the bot won't auto-merge this... so I may have to manually merge.

@MicahZoltu MicahZoltu closed this May 6, 2022
@MicahZoltu MicahZoltu reopened this May 6, 2022
@MicahZoltu MicahZoltu merged commit 9e393a7 into ethereum:master May 6, 2022
@Pandapip1 Pandapip1 deleted the patch-4 branch May 9, 2022 21:35
PowerStream3604 pushed a commit to PowerStream3604/EIPs that referenced this pull request May 19, 2022
* Include LICENCE in the Jekyll build

* Replace old licence link with new and improved licence link

* Add note to EIP-1 mandating the new link

* Maybe this fixes it?

* Rename LICENCE so that jekyll picks it up

* Add original LICENCE file back

* Delete the markdown file

* Add Jekyll header

Hopefully the tooling still detects it as CC0

* Remove Jekyll header

* Maybe this will trick Jekyll and satisfy github?

* Remove config changes

* Enable incremental build

* Will it work if I rename it?

* I'll just paste the content of the licence into the file...

* Perhaps this will work

* Replace the licence file

* Fix false positive

Co-authored-by: Micah Zoltu <micah@zoltu.net>

* Resolve feedback

* Perhaps this might work

* It didn't work

This reverts commit 55116e1.

* Will licencee still detect this correctly?

* Jekyll Preamble in licence file

* Include it?

* Licence -> License, get rid of CC0.md

* Force wording of copyright waiver

* Formatting consistent with the rest of the list

* Spelling

* Escape

* Task failed successfully

* Fix two more links

* Will this render it?

* Perhaps this will work too

* .md essential

* Fix the issues Micah noted

Co-authored-by: Micah Zoltu <micah@zoltu.net>
nachomazzara pushed a commit to nachomazzara/EIPs that referenced this pull request Jan 13, 2023
* Include LICENCE in the Jekyll build

* Replace old licence link with new and improved licence link

* Add note to EIP-1 mandating the new link

* Maybe this fixes it?

* Rename LICENCE so that jekyll picks it up

* Add original LICENCE file back

* Delete the markdown file

* Add Jekyll header

Hopefully the tooling still detects it as CC0

* Remove Jekyll header

* Maybe this will trick Jekyll and satisfy github?

* Remove config changes

* Enable incremental build

* Will it work if I rename it?

* I'll just paste the content of the licence into the file...

* Perhaps this will work

* Replace the licence file

* Fix false positive

Co-authored-by: Micah Zoltu <micah@zoltu.net>

* Resolve feedback

* Perhaps this might work

* It didn't work

This reverts commit 55116e1.

* Will licencee still detect this correctly?

* Jekyll Preamble in licence file

* Include it?

* Licence -> License, get rid of CC0.md

* Force wording of copyright waiver

* Formatting consistent with the rest of the list

* Spelling

* Escape

* Task failed successfully

* Fix two more links

* Will this render it?

* Perhaps this will work too

* .md essential

* Fix the issues Micah noted

Co-authored-by: Micah Zoltu <micah@zoltu.net>
@GIgako19929
Copy link


@GIgako19929
Copy link


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Replace the link to CC0 with a link to the LICENCE file
4 participants