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

Unreleased changelog folder #9964

Merged
merged 4 commits into from May 6, 2019

Conversation

@Zimmi48
Copy link
Member

commented Apr 16, 2019

Kind: documentation infrastructure.

  • Corresponding documentation was updated

I'm submitting this as a WIP to demonstrate what the future of the unreleased changelog will be. This should be coupled with a script extracting the relevant changelog entries for a new release (à la https://about.gitlab.com/2018/07/03/solving-gitlabs-changelog-conflict-crisis/), whose two advantages will be:

  • no more CHANGES conflict
  • no more mistake about which CHANGES section to put the entry in, especially when the PR is proposed for backporting but might be rejected, or if the PR has been waiting for a long time and the location has stalled.

The main feature demonstrated by this PR and which goes beyond what GitLab proposed is that unreleased changes are still visible in a central location (the deployed development version of the reference manual).

TODO

  • Remove commit with fake entries for demonstration purpose.
  • Wait for legacy Makefile to be removed, or update Makefile.doc as well.
  • Wait for #9939 to be merged first.

TODO for future PR

  • Create the script for extracting the changelog for a new release.
@ejgallego

This comment has been minimized.

Copy link
Member

commented Apr 16, 2019

That's cool, would be even cooler if Gitlab/Github could maintain the files for us and understand the PR numbers in them.

This comment has been minimized.

Copy link
Member Author

commented Apr 16, 2019 — with Octobox

What do you have in mind?

@ejgallego

This comment has been minimized.

Copy link
Member

commented Apr 16, 2019

What do you have in mind?

Imagine that gitlab would know all the PRs in master but not on 8.10, and these PRs have the tag changes, then it could generate the folder with the commit messages automaticaly..

I am just brainstorming tho.

@Zimmi48

This comment has been minimized.

Copy link
Member Author

commented Apr 16, 2019

This kind of brainstorming is quite welcome. It could be seen as a next step if we can determine exactly what we want. This could be implemented with the bot, for instance.

@Zimmi48

This comment has been minimized.

Copy link
Member Author

commented Apr 16, 2019

Change by Full Name, with help of Full Name.
Pull request `#NNNNN <https://github.com/coq/coq/pull/NNNNN>`_.

This comment has been minimized.

Copy link
@gares

gares Apr 17, 2019

Member

Isn't this redundant given that the file name is already containing NNNNN?

This comment has been minimized.

Copy link
@Zimmi48

Zimmi48 Apr 29, 2019

Author Member

Yes, it is, and at some point we might switch to a more clever compilation script that will add such annotations by itself, but for now, it is simpler like this.

@Zimmi48 Zimmi48 force-pushed the Zimmi48:unreleased-changelog-folder branch from d9ed434 to 757231c Apr 29, 2019

@Zimmi48

This comment has been minimized.

Copy link
Member Author

commented Apr 29, 2019

We are going to need to merge this soon and I wouldn't mind a hand to port the build changes to the Makefile (since obviously we are not going to be able to wait for #8729).

@gares

This comment has been minimized.

Copy link
Member

commented Apr 29, 2019

I was thinking that with this approach we lose the organization of changes into sections.
Is it doable to have a subdir per section?

@gares

This comment has been minimized.

Copy link
Member

commented Apr 29, 2019

I wouldn't mind a hand to port the build changes to the Makefile

We need to do that only if dune misses also 8.11 right?

@Zimmi48

This comment has been minimized.

Copy link
Member Author

commented Apr 29, 2019

I was thinking that with this approach we lose the organization of changes into sections.
Is it doable to have a subdir per section?

Yes, it should be doable but then I think we should decide section names before-hand (as opposed to letting PRs authors invent them, which often leads to duplication and inconsistencies).

I wouldn't mind a hand to port the build changes to the Makefile

We need to do that only if dune misses also 8.11 right?

No, because this PR should be merged as early as possible, whereas the removal of legacy Makefiles can still wait several weeks or months if needed.

@Zimmi48 Zimmi48 force-pushed the Zimmi48:unreleased-changelog-folder branch from f4116e6 to 378e92f Apr 30, 2019

@coqbot coqbot removed the needs: rebase label Apr 30, 2019

@Zimmi48

This comment has been minimized.

Copy link
Member Author

commented Apr 30, 2019

@gares I pushed a new commit in which there is such a division in categories. Here is the rendered result: https://coq.gitlab.io/-/coq/-/jobs/204895434/artifacts/_build/default/doc/sphinx_build/html/changes.html

@Zimmi48 Zimmi48 added this to In progress in Release process automation Apr 30, 2019

@gares

This comment has been minimized.

Copy link
Member

commented Apr 30, 2019

Awesome! do you want me to fix the Makefile?

@Zimmi48

This comment has been minimized.

Copy link
Member Author

commented Apr 30, 2019

Yes, that would be very appreciated. Feel free to push here.

@Zimmi48 Zimmi48 force-pushed the Zimmi48:unreleased-changelog-folder branch 2 times, most recently from 7bd06fc to 1d00442 May 2, 2019

@Zimmi48

This comment has been minimized.

Copy link
Member Author

commented May 4, 2019

ping @gares

@gares

This comment has been minimized.

Copy link
Member

commented May 4, 2019

Sorry I did not manage last week, I'll do my best on Monday

@coqbot coqbot added the needs: rebase label May 4, 2019

@gares

This comment has been minimized.

Copy link
Member

commented May 4, 2019

I've pushed a commit but it needs to be rebased in order to be tested. I hope I got the paths right.

@Zimmi48 Zimmi48 requested review from coq/doc-maintainers as code owners May 4, 2019

@Zimmi48 Zimmi48 modified the milestones: 8.11+beta1, 8.10+beta1 May 4, 2019

@Zimmi48

This comment has been minimized.

Copy link
Member Author

commented May 4, 2019

It turns out that the two entries moved from CHANGES.md to doc/changelog were backported already, so it is fine to backport this PR as well. A subsequent PR will ensure that these entries are integrated in the 8.10+beta1 changes before the beta release.

@Zimmi48 Zimmi48 force-pushed the Zimmi48:unreleased-changelog-folder branch from 81c89ce to 30c9f13 May 5, 2019

@Zimmi48

This comment has been minimized.

Copy link
Member Author

commented May 5, 2019

Would appreciate getting an assignee and this PR merged before another conflict arises.

@Zimmi48

This comment has been minimized.

Copy link
Member Author

commented May 5, 2019

Too late. New conflict.

Zimmi48 and others added some commits Apr 16, 2019

@Zimmi48 Zimmi48 force-pushed the Zimmi48:unreleased-changelog-folder branch from 30c9f13 to 50b1481 May 5, 2019

@Zimmi48

This comment has been minimized.

Copy link
Member Author

commented May 5, 2019

@vbgl After this new rebase, the current version of the PR cannot be backported as-is: the changelog entry doc/changelog/04-tactics/10059-change-no-check.rst would have to be dropped, unless the four PRs that are mentioned in it (#10012, #10017, #10053, #10059) are backported too.

EDIT: Actually doc/changelog/10-standard-library/09984-pairusualdecidabletypefull.rst has to be dropped as well when backporting, unless #9984 is backported.

@vbgl

This comment has been minimized.

Copy link
Contributor

commented May 6, 2019

Thanks Théo for the hint. I’ll follow your advice for back-porting after this one is merged.

@gares

This comment has been minimized.

Copy link
Member

commented May 6, 2019

OK, I'll do it. No, actually I'm co authoring it, so I should not merge it myself.

@gares gares self-assigned this May 6, 2019

@gares

gares approved these changes May 6, 2019

@gares gares removed their assignment May 6, 2019

@Zimmi48

This comment has been minimized.

Copy link
Member Author

commented May 6, 2019

@vbgl I think that it would make sense for you to be this PR's assignee, as the 8.10 RM. Note that even if there are quite a few code owners, all the changes to files that they own are quite trivial, so I wouldn't wait for everyone's approval.

@vbgl vbgl self-assigned this May 6, 2019

@vbgl

vbgl approved these changes May 6, 2019

@coqbot coqbot added this to Request 8.10 inclusion in Coq 8.10 May 6, 2019

@vbgl vbgl merged commit 50b1481 into coq:master May 6, 2019

8 checks passed

GitLab CI pipeline Pipeline completed on GitLab CI
Details
coq.coq Build #20190505.12 succeeded
Details
coq.coq (Windows) Windows succeeded
Details
coq.coq (macOS) macOS succeeded
Details
doc:ml-api:odoc: ml-api artifact Link to ml-api build artifact.
Details
doc:refman: refman artifact Link to refman build artifact.
Details
doc:refman: stdlib artifact Link to stdlib build artifact.
Details
test-suite:base Test succeeded on GitLab CI after being retried
Details

Release process automation automation moved this from In progress to Done May 6, 2019

vbgl added a commit that referenced this pull request May 6, 2019

Merge PR #9964: Unreleased changelog folder
Ack-by: SkySkimmer
Ack-by: Zimmi48
Reviewed-by: gares
Reviewed-by: vbgl

@Zimmi48 Zimmi48 deleted the Zimmi48:unreleased-changelog-folder branch May 6, 2019

vbgl added a commit to vbgl/coq that referenced this pull request May 7, 2019

@Zimmi48 Zimmi48 moved this from Request 8.10 inclusion to Shipped in 8.10+beta1 in Coq 8.10 May 9, 2019

@Zimmi48 Zimmi48 added this to History and changelog in Credits and license issues May 11, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.