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

generate doc/requirements.txt #10031

Merged
merged 2 commits into from
May 21, 2024

Conversation

geekosaur
Copy link
Collaborator

As suggested in #10030 (review)

Template B: This PR does not modify behaviour or interface

E.g. the PR only touches documentation or tests, does refactorings, etc.

Include the following checklist in your PR:

  • Patches conform to the coding conventions.
  • Is this a PR that fixes CI? If so, it will need to be backported to older cabal release branches (ask maintainers for directions).

Copy link
Collaborator

@ulysses4ever ulysses4ever left a comment

Choose a reason for hiding this comment

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

I'd expect some updates to documentation. e.g. doc/README.md. Maybe the Makefile.

@geekosaur
Copy link
Collaborator Author

Yes, this is still WIP, let me switch it to draft.

@geekosaur geekosaur marked this pull request as draft May 18, 2024 02:46
@geekosaur
Copy link
Collaborator Author

geekosaur commented May 18, 2024

Actually, I'm not sure we want to update the Makefile; it's going to be more necessary with this change, if someone wants to build docs locally. doc/README.md and possibly CONTRIBUTING.md would need to be updated.

@geekosaur geekosaur force-pushed the generate-requirements.txt branch 4 times, most recently from 7dd9d50 to 2aca7c4 Compare May 18, 2024 03:16
@geekosaur
Copy link
Collaborator Author

Okay, the basics now work. Documentation is next (tomorrow, I should go to bed…).

@ffaf1
Copy link
Collaborator

ffaf1 commented May 18, 2024

This is magnificent, the less there is the harder it breaks. Many thanks!

@geekosaur geekosaur force-pushed the generate-requirements.txt branch 2 times, most recently from a4ad174 to 17bc8c1 Compare May 18, 2024 16:58
@geekosaur
Copy link
Collaborator Author

First cut at documentation added.

@geekosaur geekosaur marked this pull request as ready for review May 18, 2024 20:44
@geekosaur
Copy link
Collaborator Author

  1. I changed the doc build rules to use the Makefile rule, so that is tested.
  2. I do not expect that this needs to be backported, but will leave the final decision to wiser heads.

Copy link
Collaborator

@ulysses4ever ulysses4ever left a comment

Choose a reason for hiding this comment

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

Long awaited improvement, thank you very much!

doc/README.md Outdated Show resolved Hide resolved
doc/README.md Outdated Show resolved Hide resolved
@geekosaur geekosaur added merge me Tell Mergify Bot to merge and removed attention: needs-review labels May 19, 2024
@mergify mergify bot added the merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days label May 21, 2024
@geekosaur geekosaur mentioned this pull request May 21, 2024
2 tasks
@geekosaur geekosaur removed the merge me Tell Mergify Bot to merge label May 21, 2024
@geekosaur
Copy link
Collaborator Author

geekosaur commented May 21, 2024

The reason this needs to be backported is that backports of subsequent changes to doc/requirements.in won't update doc/requirements.txt on 3.12, so someone would need to manually do so for the backport to actually do anything.

@geekosaur geekosaur added the squash+merge me Tell Mergify Bot to squash-merge label May 21, 2024
@mergify mergify bot merged commit 2658ac6 into haskell:master May 21, 2024
43 checks passed
@ulysses4ever
Copy link
Collaborator

@mergify backport 3.12

Copy link
Contributor

mergify bot commented May 21, 2024

backport 3.12

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request May 21, 2024
* generate doc/requirements.txt

As suggested in #10030 (review)

* generate doc/requirements.txt

As suggested in #10030 (review)

(cherry picked from commit 2658ac6)
Mikolaj pushed a commit that referenced this pull request May 22, 2024
* generate doc/requirements.txt

As suggested in #10030 (review)

* generate doc/requirements.txt

As suggested in #10030 (review)

(cherry picked from commit 2658ac6)
mergify bot added a commit that referenced this pull request May 22, 2024
generate doc/requirements.txt (backport #10031)
wismill pushed a commit to wismill/cabal that referenced this pull request May 26, 2024
* generate doc/requirements.txt

As suggested in haskell#10030 (review)

* generate doc/requirements.txt

As suggested in haskell#10030 (review)
wismill pushed a commit to wismill/cabal that referenced this pull request May 27, 2024
* generate doc/requirements.txt

As suggested in haskell#10030 (review)

* generate doc/requirements.txt

As suggested in haskell#10030 (review)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days squash+merge me Tell Mergify Bot to squash-merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants