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

Release notes for GAP 4.9 #1699

Closed
fingolfin opened this issue Sep 7, 2017 · 9 comments
Closed

Release notes for GAP 4.9 #1699

fingolfin opened this issue Sep 7, 2017 · 9 comments
Assignees
Labels
gapdays2017-fall Issues and PRs that arose at https://www.gapdays.de/gapdays2017-fall topic: documentation Issues and PRs related to documentation
Milestone

Comments

@fingolfin
Copy link
Member

fingolfin commented Sep 7, 2017

Below is a list of pull requests which are NOT in stable-4.8, formatted as a task list.

If you want to help, do this: Take any PR which has not been "ticked" yet. Look at it, and decide whether it contains changes that should be mentioned in the release notes. If yes, do so.
In either case, once you are done reviewing the PR, tick it, so that nobody else has to look at it.

TODO: explain how / where to add the release notes... perhaps on a Wiki page, or a HackMD file?

UPDATE: turns out that clicking the checkboxes is veery slow on GitHub. I will look into a way to first reduce the list some more...

@fingolfin fingolfin added this to the GAP 4.9.0 milestone Sep 7, 2017
@gap-system gap-system deleted a comment from fingolfin Sep 7, 2017
@olexandr-konovalov olexandr-konovalov added topic: documentation Issues and PRs related to documentation gapdays2017-fall Issues and PRs that arose at https://www.gapdays.de/gapdays2017-fall labels Sep 7, 2017
@gap-system gap-system deleted a comment from fingolfin Sep 12, 2017
@gap-system gap-system deleted a comment from fingolfin Sep 12, 2017
@olexandr-konovalov
Copy link
Member

The task of walking through all PR merged to master but not into stable is quite tedious. We are doing that in a shared document - if anyone wants to help, ask one of the assignees for this issue for details.

When we will have that completed, we can update release notes on Wiki and add the new chapter to the doc/changes manual.

To make collecting release notes easier, @fingolfin created new label "not-for-release-notes". Otherwise, if the PR should be mentioned in release notes, please use one or several more specific labels, e.g. "enhancement", "new feature" etc.

@olexandr-konovalov
Copy link
Member

@fingolfin we certainly need to update the list of PRs at hackmd for that...

@fingolfin
Copy link
Member Author

I cand do taht eventually, but in the meantime, there is plenty of work already there, no? And I am reluctant to invest any work into it unless I know it won't be wasted

@olexandr-konovalov
Copy link
Member

Yes, of course didn't mean "for that" = "to continue work on this", it's not preventing from sorting existing items in the list. But hopefully next week we might need more items, and you may plan that in your schedule then, if we have to make 4.9 beta this year.

@fingolfin
Copy link
Member Author

(summary of discussion on Slack follows)
Instead of running my (super hacky) scripts again, I suggest that we instead use GitHub's filtering system to find PRs not yet covered. Here is a query URL which only shows PRs which were merged into master since the last GAP days, and for which the labels "not for release notes" and "added to release notes" are not set: https://github.com/gap-system/gap/pulls?page=4&q=is%3Apr+-label%3A%22not+for+release+notes%22+-label%3A%22added+to+release+notes%22+is%3Aclosed+merged%3A%3E%3D2017-09-01+is%3Amerged++base%3Amaster

I already went through a couple dozen PRs previously listed in that query and added the "not for release notes" label. As I write this, 87 PRs remain in that list.

Now to make the release notes, we can go through PRs in the issues, and decide what to do with it: Either they are for the release notes, then let's add the PR there, and afterwards give it the "added to release notes" label. Otherwise, add the "not for release notes" label. In either case, it will be removed from the list shown by the query.

@olexandr-konovalov
Copy link
Member

Now 70 remain!

@olexandr-konovalov
Copy link
Member

olexandr-konovalov commented Jan 20, 2018

OK, in the hackmd list of pull requests about 20 left now - belong to @markuspf @fingolfin @ChrisJefferson and @hulpke. I will look at them later, but if you wish, please have a look and handle them. I have left them because either I may have a doubt whether to include them or not, or they could be better described by you, or should be incorporated into some other more global item, or contain a large collection of changes, so have to be checked and maybe some of them should be described, some not...

That's not all - we need also to select PRs from GitHub, using these updated links:

@olexandr-konovalov
Copy link
Member

olexandr-konovalov commented Jan 29, 2018

So, this task has achieved some milestone. All PRs that were in the hackmd.io document and all subsequent PRs that went to master before branching off stable-4.9 and then into stable-4.9 are processed. However, the text still requires some polishing and editing, and maintenance for future PRs going into stable-4.9. For that purpose, I have now moved the text from hackmd.io document to the following wiki page: https://github.com/gap-system/gap/wiki/GAP-4.9-release-notes

My plan is to fix the text on that page and include a link to it into the announcement of GAP 4.9 beta. While we will be preparing for the first public release of GAP 4.9, that page may be further edited and extended, and converted (maybe with shortening) into a chapter of the Changes manual).

It is easy to find this page from the GAP GitHub wiki, as it is visible in the right navigation bar (and does not require a secret link like hackmd). For new PRs that will be going into stable-4.9, there is a query there and instructions how to process those PRs.

Remark: there is also a similar page for GAP 4.10 release notes, with a different query and similar instructions here: https://github.com/gap-system/gap/wiki/GAP-4.10-release-notes (cf. also #2139).

@olexandr-konovalov
Copy link
Member

GAP 4.9.0 published today, see release notes at https://github.com/gap-system/gap/wiki/GAP-4.9-release-notes. This issue is now closed and superseded by #2152 (Release notes for GAP 4.9.1).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
gapdays2017-fall Issues and PRs that arose at https://www.gapdays.de/gapdays2017-fall topic: documentation Issues and PRs related to documentation
Projects
None yet
Development

No branches or pull requests

4 participants