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 version 2.1 #10416

Closed
timvandermeij opened this issue Jan 4, 2019 · 13 comments
Closed

Release version 2.1 #10416

timvandermeij opened this issue Jan 4, 2019 · 13 comments
Labels

Comments

@timvandermeij
Copy link
Contributor

There some some api-minor patches and the example code on the website changed to the new syntax for getViewport, which caused some confusion for people that use the NPM package. We should make a release of version 2.1 to solve this and other issues we found and fixed after version 2.0.

@wojtekmaj
Copy link
Contributor

Hi Tim, is there any schedule? I'm really looking forward to this release!

@timvandermeij
Copy link
Contributor Author

timvandermeij commented Jan 5, 2019

I don't think we have anything in the queue holding back a release. I don't mind taking care of this, so perhaps we can already do it next week if everyone agrees (/cc @brendandahl @yurydelendik @Snuffleupagus to make sure I'm not forgetting about something that really needs to be in version 2.1).

The getViewport change is backwards compatible; refer to https://github.com/mozilla/pdf.js/pull/10369/files#diff-0ecad279ed2252e3eb47a4d96ec1463cR921. The old way of calling will still work and show a deprecation notice that the user should change it. It will only be removed in a major version (3.x).

@Snuffleupagus
Copy link
Collaborator

make sure I'm not forgetting about something that really needs to be in version 2.1

Ideally, issue #10391 really ought to be fixed before the next release.

@niels-van-den-broeck
Copy link

Any update on when the npm package will be updated?

@timvandermeij
Copy link
Contributor Author

I'm able to make the release soon, but I'm a bit short on time to also address the issue mentioned above. @brendandahl Last time we released version 2.0, did you look at why the master branch for pdfjs-dist was not updated (see #10391). It would be nice if we can get that fixed before making a new release.

@timvandermeij
Copy link
Contributor Author

The issue above is now done, so I'll try to make the new release this weekend unless there are major objections (please comment here in that case). Doing that will also resolve the getViewport confusion.

@timvandermeij
Copy link
Contributor Author

timvandermeij commented Feb 9, 2019

The release of version 2.1.245 is complete. However, because of misunderstood instructions on https://github.com/mozilla/pdf.js/wiki/Release-Process the version is called 2.2.2 on pdfjs-dist/NPM because I updated the pdfjs.config file before making the release. To prevent this from happening again, I updated to page to remove the section from https://github.com/mozilla/pdf.js/wiki/Release-Process/055c021ab425b3e88877a40d8cb18d3956d4832e about updating the version prefix since I read that as that it should happen first because api-minor changes were merged. Moreover, I highlighted the part about the pre-release checkbox since it's not very visible on GitHub and therefore I forgot to check it.

@brendandahl Is there a way we can change the version number to 2.1.245 on pdfjs-dist/NPM? I don't know if that leads to problems if users already updated to this new release, since that would mean a downgrade in version number. Otherwise, we could also keep the release as-is since the release process is now updated to make sure the next release goes correctly again.

@wojtekmaj
Copy link
Contributor

wojtekmaj commented Feb 10, 2019

@timvandermeij Within 72 hours you can unpublish a version from npm. You could then publish a correct version again.

https://docs.npmjs.com/cli/unpublish

I highly encourage you to do this to avoid confusion.

@timvandermeij
Copy link
Contributor Author

timvandermeij commented Feb 10, 2019

@wojtekmaj Thank you, I didn't know that.

@brendandahl Since the process is automated, I think only the bots or someone with the Node.js publisher account can do this. If we can remove it from NPM this way first, we can then remove it from pdfjs-dist manually and try to create a new release. If you're on IRC on Monday, we can discuss it further.

@timvandermeij
Copy link
Contributor Author

timvandermeij commented Feb 11, 2019

The following steps should be taken:

  • Unpublish the release on NPM
  • Unpublish the release on pdfjs-dist
    • Remove the tag
    • Remove the release
    • Remove the commit
  • Unpublish the release on pdf.js
    • Remove the tag
    • Remove the release
    • Revert the pdfjs.config version bumps
  • Redo the version 2.1 as a pre-release with the correct version number

@ghost
Copy link

ghost commented Feb 14, 2019

Any new on the re-release of version 2.1? I can see the pdfjs-dist package was unlisted.

@timvandermeij
Copy link
Contributor Author

I'll make the new release this weekend.

@timvandermeij
Copy link
Contributor Author

Closing since v2.1.266 is now published as a pre-release (next tag on NPM).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants