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

doc(*): switch from update-mathlib to leanproject #2093

Merged
merged 6 commits into from
Mar 12, 2020
Merged

doc(*): switch from update-mathlib to leanproject #2093

merged 6 commits into from
Mar 12, 2020

Conversation

gebner
Copy link
Member

@gebner gebner commented Mar 6, 2020

TO CONTRIBUTORS:

Make sure you have:

  • reviewed and applied the coding style: coding, naming
  • reviewed and applied the documentation requirements
  • for tactics:
  • make sure definitions and lemmas are put in the right files
  • make sure definitions and lemmas are not redundant

If this PR is related to a discussion on Zulip, please include a link in the discussion.

For reviewers: code review check list

sgouezel
sgouezel reviewed Mar 6, 2020
View reviewed changes
docs/install/linux.md Outdated Show resolved Hide resolved
@gebner @sgouezel
Apply suggestions from code review
fb1f8dd 
Co-Authored-By: sgouezel <sebastien.gouezel@univ-rennes1.fr>
@gebner
Copy link
Member Author

gebner commented Mar 6, 2020

This PR should only be merged once @PatrickMassot has pushed the mathlibtools release to pypi.

PatrickMassot
PatrickMassot reviewed Mar 6, 2020
View reviewed changes
docs/install/project.md Outdated
@@ -11,10 +11,10 @@ terminal.
* Then go to a folder where you want to create a project in a subfolder
`my_project`, and type:
```bash
leanpkg new my_project
leanpkg +leanprover-community/lean:3.6.1 new my_project
Copy link
Member

Choose a reason for hiding this comment

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

This is outdated. The new workflow is leanproject new my_project, nothing else.

Copy link
Member Author

Choose a reason for hiding this comment

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

Sweet.

docs/contribute/index.md
- You can do this by running the following commands (anywhere in the `mathlib` repository).
5. You can use `leanproject get-cache` to fetch `.olean` binaries.
The `.olean` binaries take two hours to generate, so they might not yet be available if you're on the master branch.
If you checkout the remote branch `lean-3.6.1` then you can always get olean binaries:
Copy link
Member

Choose a reason for hiding this comment

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

Unfortunately this is not yet true, this is why I didn't want to merge.

Copy link
Member Author

Choose a reason for hiding this comment

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

The oleans should always be available for lean-3.6.1 because we first push them to azure before updating the branch. It's only master and feature branches that lag behind.

Copy link
Member

Choose a reason for hiding this comment

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

They are now available within ~30 seconds, unless the most recent commit came from a PR from a fork.

PatrickMassot
PatrickMassot reviewed Mar 6, 2020
View reviewed changes
Copy link
Member

@PatrickMassot PatrickMassot left a comment

Choose a reason for hiding this comment

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

The part about using an existing project is outdated. The new workflow is leanproject get tutorials. You can replace tutorials with github_user/project or even a full git url.

@gebner
Copy link
Member Author

gebner commented Mar 6, 2020

The new workflow is leanproject get tutorials

Sweet.

robertylewis
robertylewis reviewed Mar 11, 2020
View reviewed changes
Copy link
Member

@robertylewis robertylewis left a comment

Choose a reason for hiding this comment

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

Now that leanproject has landed, we should get this finished and merged!

docs/contribute/index.md
- You can do this by running the following commands (anywhere in the `mathlib` repository).
5. You can use `leanproject get-cache` to fetch `.olean` binaries.
The `.olean` binaries take two hours to generate, so they might not yet be available if you're on the master branch.
If you checkout the remote branch `lean-3.6.1` then you can always get olean binaries:
Copy link
Member

Choose a reason for hiding this comment

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

They are now available within ~30 seconds, unless the most recent commit came from a PR from a fork.

@jcommelin
Copy link
Member

They are now available within ~30 seconds, unless the most recent commit came from a PR from a fork.

@robertylewis I'm confused. Does this mean we don't have to wait 1hr for the linter to complete?

@PatrickMassot
Copy link
Member

I think this is good to go, but I won't merge since I've done the latest commit.

@robertylewis
Copy link
Member

They are now available within ~30 seconds, unless the most recent commit came from a PR from a fork.

@robertylewis I'm confused. Does this mean we don't have to wait 1hr for the linter to complete?

oleans are pushed to the server before the linter runs.

@bryangingechen bryangingechen added awaiting-review The author would like community review of the PR and removed not-ready-to-merge labels Mar 12, 2020
@PatrickMassot PatrickMassot added ready-to-merge All that is left is for bors to build and merge this PR. (Remember you need to say `bors r+`.) and removed awaiting-review The author would like community review of the PR labels Mar 12, 2020
@mergify mergify bot merged commit f5787f5 into master Mar 12, 2020
@mergify mergify bot deleted the leanproject-docs branch March 12, 2020 15:26
anrddh pushed a commit to anrddh/mathlib that referenced this pull request May 15, 2020
@gebner @sgouezel
@PatrickMassot @bryangingechen @mergify @anrddh
doc(*): switch from update-mathlib to leanproject (leanprover-communi…
2773124 
…ty#2093)

* doc(*): switch from update-mathlib to leanproject

* Apply suggestions from code review

Co-Authored-By: sgouezel <sebastien.gouezel@univ-rennes1.fr>

* Use shiny new `leanproject new` and `leanproject get`

* documentation tweaks

* project.md tweaks

Co-authored-by: sgouezel <sebastien.gouezel@univ-rennes1.fr>
Co-authored-by: Patrick Massot <patrickmassot@free.fr>
Co-authored-by: Bryan Gin-ge Chen <bryangingechen@gmail.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
anrddh pushed a commit to anrddh/mathlib that referenced this pull request May 16, 2020
@gebner @sgouezel
@PatrickMassot @bryangingechen @mergify @anrddh
doc(*): switch from update-mathlib to leanproject (leanprover-communi…
7eca214 
…ty#2093)

* doc(*): switch from update-mathlib to leanproject

* Apply suggestions from code review

Co-Authored-By: sgouezel <sebastien.gouezel@univ-rennes1.fr>

* Use shiny new `leanproject new` and `leanproject get`

* documentation tweaks

* project.md tweaks

Co-authored-by: sgouezel <sebastien.gouezel@univ-rennes1.fr>
Co-authored-by: Patrick Massot <patrickmassot@free.fr>
Co-authored-by: Bryan Gin-ge Chen <bryangingechen@gmail.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@robertylewis robertylewis robertylewis left review comments

@bryangingechen bryangingechen bryangingechen left review comments

@sgouezel sgouezel sgouezel left review comments

@PatrickMassot PatrickMassot PatrickMassot approved these changes

Assignees

@PatrickMassot PatrickMassot

Labels
ready-to-merge All that is left is for bors to build and merge this PR. (Remember you need to say `bors r+`.)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@gebner @jcommelin @PatrickMassot @robertylewis @bryangingechen @sgouezel