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

Update Composer.json #12

Merged
merged 1 commit into from
Apr 30, 2024
Merged

Update Composer.json #12

merged 1 commit into from
Apr 30, 2024

Conversation

AJCJ1
Copy link
Contributor

@AJCJ1 AJCJ1 commented Apr 30, 2024

In this change, I have updated the composer.json to follow Packagist recommendations.

The default installation when running:

composer require urlbox/screenshots

remained as 3.0.0 due to 3.0.0 being the last tagged release on the github repo. Packagist follows the latest tagged release. Minor changes were made in Oct 2023, but a new tag was not created for those changes.

Because a new tagged release was not made (with the zipped source code), the updates did not take effect, meaning the default installation version did not include those Oct 2023 updates.

Additionally, if a tagged release were to be made without an update to the composer.json version, Packagist validation would have failed.

Packagist uses the command:

composer validate

to validate composer files, and when static versioning is provided it warns:

./composer.json is valid, but with a few warnings

See https://getcomposer.org/doc/04-schema.md for details on the schema

# General warnings

- The version field is present, it is recommended to leave it out if the package is published on Packagist.

This is recommended, because if there is a version mismatch (IE 3.0.0) with the latest tag (EG 3.0.1), it will fail validation and not upload to Packagist:

https://blog.packagist.com/tagged-a-new-release-for-composer-and-it-wont-show-up-on-packagist/

As a result I have removed the static version from the composer.json. If merged into master, changes will only take effect if a new tagged release is made.

I believe the changes from Oct 2023 would fall under a minor change, as it is backward compatible, but introduces a new version of PSR7, and the flexibility to negate what would otherwise require an empty string in the place of the $webhookSecret to function EG: Urlbox::fromCredentials($key, $secret, '');

The change from October 2023 was made here:
3c1a00b

This would make the next release tag 3.1.0.

@AJCJ1 AJCJ1 requested a review from cjroebuck April 30, 2024 10:29
@AJCJ1 AJCJ1 linked an issue Apr 30, 2024 that may be closed by this pull request
Copy link
Collaborator

@cjroebuck cjroebuck left a comment

Choose a reason for hiding this comment

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

Looks good, thanks for the explanation. Just to confirm should the next release tag be 3.1.0 or 3.0.1 for the changes made last year that haven't yet been released under a new tag?

@AJCJ1
Copy link
Contributor Author

AJCJ1 commented Apr 30, 2024

Looks good, thanks for the explanation. Just to confirm should the next release tag be 3.1.0 or 3.0.1 for the changes made last year that haven't yet been released under a new tag?

Thinking on it it could be a patch, as its less an addition/enhancement and more a bug fix, so 3.0.1

@cjroebuck cjroebuck merged commit f3571d4 into master Apr 30, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Composer version with new release tag
2 participants