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

Add porting bots to diagram #8

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ graph LR;
mathlib3[(mathlib repo)]
port-comments[/"<a href='https://raw.githubusercontent.com/wiki/leanprover-community/mathlib4/port-comments.md'>port comments</a>"/]
run_port_status["<a href='https://github.com/leanprover-community/mathlib4/blob/master/scripts/run_port_status.sh'>run_port_status.sh</a><br />(On @jcommelin's server every 30 minutes)"]
port-grph-bot["A bot in the <a href='https://leanprover.zulipchat.com/#narrow/stream/287929-mathlib4/topic/port.20progress'>port progress Zulip thread</a><br />On @semorrison's server every 4(?) hours"]
port-status-bot["A bot in the <a href='https://leanprover.zulipchat.com/#narrow/stream/287929-mathlib4/topic/port.20progress'>port progress Zulip thread</a><br />On @semorrison's server every day"]
Comment on lines +12 to +13
Copy link
Member

Choose a reason for hiding this comment

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

@jcommelin: I added a longer description to these; I don't really understand what the difference between them is. Can you elaborate?

Copy link
Member Author

Choose a reason for hiding this comment

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

@eric-wieser One of them generates the graphs (hosted on Scott's server) that you can open by clicking the links in the tables with stats in the port progress thread.

The other bot is responsible for calculating those stats and posting the tables to the zulip thread.

port-wiki[/"<a href='https://github.com/leanprover-community/mathlib/wiki/mathlib4-port-status'>port wiki</a>"/]
port-wiki-yaml[/"<a href='https://github.com/leanprover-community/mathlib/wiki/mathlib4-port-status-yaml'>port wiki V2</a>"/]
mathlibtools[[mathlibtools]]
Expand All @@ -28,10 +30,13 @@ graph LR;
mathlib3 <-----> mathlib3-comments;

port-wiki-yaml-->mathlib-port-status-ci;
mathlibtools-- "Used only for the <code>/old</code> page" -->mathlib-port-status-ci;
mathlibtools-.->|"Only for<br /><code>/old</code>"| mathlib-port-status-ci;
mathlib3-->mathlib-port-status-ci;
mathlib4-->mathlib-port-status-ci;
mathlib-port-status-ci-->mathlib-port-status;

mathlibtools-->port-grph-bot;
mathlibtools-->port-status-bot;
```

## Using the github api
Expand Down