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

Changelog for v3.3.1 #830

Merged
merged 5 commits into from
Feb 11, 2022
Merged

Changelog for v3.3.1 #830

merged 5 commits into from
Feb 11, 2022

Conversation

Jaifroid
Copy link
Member

@Jaifroid Jaifroid commented Feb 9, 2022

Please check if the descriptions are accurate for the changes regarding the Ubuntu Touch app.

I include 3.3.1 under the 3.3 milestone, so if people check the closed milestones, they will see all the commits for 3.3.0 and 3.3.1. I think this makes more sense than creating a specific milestone for 3.3.1, given that it is a minor version.

@Jaifroid Jaifroid added the build Code relating to building, publishing, or maintaining the app label Feb 9, 2022
@Jaifroid Jaifroid added this to the v3.3 milestone Feb 9, 2022
@Jaifroid Jaifroid self-assigned this Feb 9, 2022
@Jaifroid
Copy link
Member Author

Jaifroid commented Feb 9, 2022

@cibersheep Would you mind checking the descriptions re. Ubuntu Touch?

CHANGELOG.md Outdated

* NOTICE: This is a bugfix release to fix critical errors with the Ubuntu Touch app. For main changelog, see v3.3.0 below.
* FIX: Improve packaging for the Ubuntu Touch app
* FIX: Provide platform-compliant ID for Ubuntu Touch app
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think the id of the UT app has been changed.

Copy link
Contributor

Choose a reason for hiding this comment

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

Not the id but the hook name. That affects where several files are stored (.desktop, manifest and appamor). Also, logs will show kiwix_[...] instead of ubports_small_webapp.

Copy link
Contributor

Choose a reason for hiding this comment

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

I suppose it means the user will loose their settings (which are stored either in cookies or in the LocalStorage of the underlying browser).
I don't think it's a big issue, but it would be worth mentioning it in the changelog.

Copy link
Member Author

Choose a reason for hiding this comment

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

So, how can I word it? -

  • Provide a platform-compliant hook name for the Ubuntu Touch app (note that settings may be lost when upgrading to this version)

Copy link
Contributor

Choose a reason for hiding this comment

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

That sounds great

Copy link
Contributor

Choose a reason for hiding this comment

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

If you commit your wording proposal @Jaifroid , we might merge this PR (and #832 if you want), then release 3.3.1.
If you agree, of course

Copy link
Member Author

Choose a reason for hiding this comment

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

OK, will commit wording, but we should wait till we have a sure date (12th Feb) to add to this PR before merging, right?

Copy link
Member Author

Choose a reason for hiding this comment

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

Should we add mention of mitigating against log4js exploit? It's more testing-related than app-related. Don't want to scare people! On the other hand might be good to show we're up to date...

Copy link
Contributor

Choose a reason for hiding this comment

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

npm is only used for running tests for now, so log4js does not end up in the packages we deploy.
So I would not mention it in the changelog file.

OK to wait for the date, but it's not an issue if it's "wrong" of one or two days, IMHO

@mossroy
Copy link
Contributor

mossroy commented Feb 9, 2022

I include 3.3.1 under the 3.3 milestone, so if people check the closed milestones, they will see all the commits for 3.3.0 and 3.3.1. I think this makes more sense than creating a specific milestone for 3.3.1, given that it is a minor version.

Second thought, I dont think we should "merge" 3.3.0 and 3.3.1 milestones on github. We should be clear on what is included in each version.
It's very common to have bugfix releases, and not an issue if they have very few changes. Plus we correctly use the major.minor.patch versioning scheme, that is meaningful by itself

I can handle that if you want

@mossroy mossroy mentioned this pull request Feb 9, 2022
18 tasks
@cibersheep
Copy link
Contributor

@cibersheep Would you mind checking the descriptions re. Ubuntu Touch?

The description of the app will be visible when published on the OpenStore

Icon and splash (looks paler because is difficult to screenshot it, too quick XD) on real device

imatge imatge

@mossroy
Copy link
Contributor

mossroy commented Feb 9, 2022

@cibersheep : I suppose @Jaifroid meant that he wanted you to check the description of changes he wrote in this PR

@mossroy mossroy modified the milestones: v3.3, v3.3.1 Feb 9, 2022
@mossroy
Copy link
Contributor

mossroy commented Feb 9, 2022

I can handle that if you want

I did it: created milestone 3.3.1 https://github.com/kiwix/kiwix-js/milestone/28 , and moved the corresponding issues in it (hope I did not forget any)

@Jaifroid
Copy link
Member Author

Jaifroid commented Feb 9, 2022

I did it: created milestone 3.3.1 https://github.com/kiwix/kiwix-js/milestone/28 , and moved the corresponding issues in it (hope I did not forget any)

OK, great! That makes sense. Just for the record, my reasoning was that our milestones are large (major) categories that only have two digits, whereas we give releases numbered with three digits. But I agree it is best to have a milestone per release, especially as this turned out to have a bit more in it than I expected.

@cibersheep
Copy link
Contributor

@cibersheep Would you mind checking the descriptions re. Ubuntu Touch?

Answering properly now (^_^) it looks great!

@kelson42
Copy link
Collaborator

@cibersheep Thank you very much for your help!

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Show resolved Hide resolved
@Jaifroid
Copy link
Member Author

@mossroy I'm merging this now, so you're free to create the tag at any point tomorrow or Sunday. I presume we're only releasing this for Ubuntu Touch, plus the PWA that should automatically update if all goes well, nothing else. I think we did all the necessary testing last week. The app code hasn't changed other than the correcting of the race condition preventing load of decompressors. But let me know if it needs more manual testing.

@Jaifroid Jaifroid merged commit 374d184 into master Feb 11, 2022
@Jaifroid Jaifroid deleted the Changelog-for-v3.3.1 branch February 11, 2022 18:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Code relating to building, publishing, or maintaining the app
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants