Reference netscape-bookmark-parser & allow generating custom release archives #608

virtualtam · 2016-07-23T17:43:28Z

reference https://github.com/shaarli/netscape-bookmark-parser as a Composer VCS repository
allow generating custom release archives (tarball, zip) containing 3rd-party dependencies

TODO:

check on a dummy fork that GitHub-generated release archives can be replaced/superseded by manually uploaded archives
tweak git describe output (used to name archives)
archiving commands are currently quiet - set them to be verbose?

Relates to shaarli#607 Relates to kafene/netscape-bookmark-parser#6 The Shaarli-forked version is checked out as a VCS repository. Signed-off-by: VirtualTam <virtualtam@flibidi.net>

ArthurHoaro · 2016-07-25T08:28:23Z

composer.json

    "require": {
-        "php": ">=5.3.4"
+        "php": ">=5.3.4",
+        "kafene/netscape-bookmark-parser": "dev-shaarli-stable"


Shouldn't we reference the fork?

By adding our fork as a VCS repository (just above), kafene/netscape-bookmark-parser resolves to our GitHub fork; it's not the more elegant solution, but is suitable since the upstream version has no recent tag

Oh, I didn't know that. Cool feature.

ArthurHoaro · 2016-07-25T08:46:12Z

check on a dummy fork that GitHub-generated release archives can be replaced/superseded by manually uploaded archives

It adds the uploaded files: https://github.com/ArthurHoaro/drunken-octo-hipster/releases/tag/666

virtualtam · 2016-07-25T09:08:59Z

It adds the uploaded files

Thanks ;-)

To avoid conflicts/confusion, we should upload the additional archives under a different name, e.g.:

we push a vX.Y.Z tag and create the matching GH release notes
GH provides git-archives as vX.Y.Z.tar and vX.Y.Z.zip
we can upload custom archives as vX.Y.Z-full.tar and vX.Y.Z-full.zip

virtualtam · 2016-07-25T20:10:37Z

Thanks for the feedback!

PR updated as follows:

append -full to the generated archive names, e.g.:
- v0.7.0-41-g9860d31-full.zip for the current revision - 41st commit following the v0.7.0 tag, identified by short-sha1 g9860d31
- vX.Y.Z-full.zip when on the vX.Y.Z tag
enable verbose output when including 3rd-party deps to the archives
- tar: v flag, e.g. tar cvf
- zip defaults to being verbose
- we may set them quiet again when there are a bit more dependencies ;-)

nodiscc · 2016-07-25T21:17:15Z

@virtualtam can you prepend shaarli- to the archive names? EG. shaarli-vX.Y.Z-full.zip. Makes the file easier to identify when in another context (find/locate/unsorted random files in a directory...)

Everything else is great 👍

Relates to shaarli#607 Archive creation process (tar, zip): - let Composer resolve functional (no-dev) dependencies - call git-archive to generate a release archive - include 3rd-party dependencies to the generated archive Signed-off-by: VirtualTam <virtualtam@flibidi.net>

virtualtam · 2016-07-25T21:55:35Z

Sure, PR updated :)

Relates to shaarli#607 Relates to shaarli#608 Relates to shaarli#493 (abandoned) Additions: - use Composer's autoload to load 3rd-party dependencies under vendor/ Modifications: - [router] use the same endpoint for bookmark upload/import dialog WIP: - [import] replace the current parser with a generic, stable parser TODO: - [index] display an error if 3rd-party dependencies are missing - [template] add options for bookmark imports - flat vs. nested structure - default tags - default visibility - [tests] ensure bookmarks are properly parsed and imported in the LinkDB - reuse reference input from the parser's test data See: - https://github.com/shaarli/netscape-bookmark-parser - https://getcomposer.org/doc/01-basic-usage.md#autoloading Signed-off-by: VirtualTam <virtualtam@flibidi.net>

Relates to shaarli#607 Relates to shaarli#608 Relates to shaarli#493 (abandoned) Additions: - use Composer's autoload to load 3rd-party dependencies under vendor/ Modifications: - [import] replace the current parser with a generic, stable parser - move code to application/NetscapeBookmarkUtils - improve status report after parsing - [router] use the same endpoint for bookmark upload/import dialog TODO: - [template] add options for bookmark imports - flat vs. nested structure - default tags - [tests] ensure bookmarks are properly parsed and imported in the LinkDB - reuse reference input from the parser's test data See: - https://github.com/shaarli/netscape-bookmark-parser - https://getcomposer.org/doc/01-basic-usage.md#autoloading Signed-off-by: VirtualTam <virtualtam@flibidi.net>

Relates to shaarli#607 Relates to shaarli#608 Relates to shaarli#493 (abandoned) Additions: - use Composer's autoload to load 3rd-party dependencies under vendor/ Modifications: - [import] replace the current parser with a generic, stable parser - move code to application/NetscapeBookmarkUtils - improve status report after parsing - [router] use the same endpoint for both bookmark upload and import dialog - [template] update bookmark import options TODO: - [tests] ensure bookmarks are properly parsed and imported in the LinkDB - reuse reference input from the parser's test data See: - https://github.com/shaarli/netscape-bookmark-parser - https://getcomposer.org/doc/01-basic-usage.md#autoloading Signed-off-by: VirtualTam <virtualtam@flibidi.net>

Relates to shaarli#607 Relates to shaarli#608 Relates to shaarli#493 (abandoned) Additions: - use Composer's autoload to load 3rd-party dependencies under vendor/ Modifications: - [import] replace the current parser with a generic, stable parser - move code to application/NetscapeBookmarkUtils - improve status report after parsing - [router] use the same endpoint for both bookmark upload and import dialog - [template] update bookmark import options WIP: - [tests] ensure bookmarks are properly parsed and imported in the LinkDB - reuse reference input from the parser's test data See: - https://github.com/shaarli/netscape-bookmark-parser - https://getcomposer.org/doc/01-basic-usage.md#autoloading Signed-off-by: VirtualTam <virtualtam@flibidi.net>

Relates to shaarli#607 Relates to shaarli#608 Relates to shaarli#493 (abandoned) Additions: - use Composer's autoload to load 3rd-party dependencies under vendor/ Modifications: - [import] replace the current parser with a generic, stable parser - move code to application/NetscapeBookmarkUtils - improve status report after parsing - [router] use the same endpoint for both bookmark upload and import dialog - [template] update bookmark import options - allow adding tags to all imported links - allow selecting the visibility (privacy) of imported links WIP: - [tests] ensure bookmarks are properly parsed and imported in the LinkDB - reuse reference input from the parser's test data See: - https://github.com/shaarli/netscape-bookmark-parser - https://getcomposer.org/doc/01-basic-usage.md#autoloading Signed-off-by: VirtualTam <virtualtam@flibidi.net>

Relates to shaarli#607 Relates to shaarli#608 Relates to shaarli#493 (abandoned) Additions: - use Composer's autoload to load 3rd-party dependencies under vendor/ Modifications: - [import] replace the current parser with a generic, stable parser - move code to application/NetscapeBookmarkUtils - improve status report after parsing - [router] use the same endpoint for both bookmark upload and import dialog - [template] update bookmark import options - allow adding tags to all imported links - allow selecting the visibility (privacy) of imported links - [tests] ensure bookmarks are properly parsed and imported in the LinkDB - reuse reference input from the parser's test data See: - https://github.com/shaarli/netscape-bookmark-parser - https://getcomposer.org/doc/01-basic-usage.md#autoloading Signed-off-by: VirtualTam <virtualtam@flibidi.net>

alexisju · 2016-08-17T07:48:24Z

Regarding this specific-point: drag-and-drop Shaarli installs, I've added a couple extra targets in #608 to the Makefile, that will enable us to generate, upload and provide full-featured Shaarli releases, i.e. containing Shaarli + third-party dependencies normally resolved through Composer.

Ok, it sounds nice :-) Will development version also available with all dependencies?

nodiscc · 2016-08-17T07:57:14Z

I don't think so, unless someone volunteers to generate a new ZIP with all dependencies for each new commit on master, and upload it somewhere. (Maybe it can be automated)

alexisju · 2016-08-17T08:01:32Z

So it will not possible anymore to update shaarli by git :(

nodiscc · 2016-08-17T08:59:27Z

Yes it will still be possible, but you will have to run composer after each git pull. See here for a discussion about pros/cons of this change.

virtualtam · 2016-08-17T10:36:55Z

@alexisju if you have Git on your server, you may also be able to download Composer locally and write a simple script or Makefile to handle your Shaarli updates

I do this for all PHP software running on my server, basically it amounts to:

updating Git sources
updating PHP dependencies through Composer

ArthurHoaro · 2016-10-14T09:27:51Z

@virtualtam: the archives generated with this target contain the Shaarli files "directly", while Github auto-generated archives contain them in a sub-folder. Is there a reason behind this? If not it might be a good idea to preserve the same behaviour.

virtualtam · 2016-10-14T12:57:12Z

No reason that I can think of, I'll make a patch so we have the same file structure everywhere :)

Relates to shaarli#607 Relates to shaarli#608 Modifications: - match the arborescence of the archives provided by GitHub - generate compressed tarballs Signed-off-by: VirtualTam <virtualtam@flibidi.net>

virtualtam · 2016-10-16T18:06:35Z

=> #661

Relates to shaarli#607 Relates to shaarli#608 Modifications: - match the arborescence of the archives provided by GitHub - generate compressed tarballs Signed-off-by: VirtualTam <virtualtam@flibidi.net>

Relates to #607 Relates to #608 Relates to #493 (abandoned) Additions: - use Composer's autoload to load 3rd-party dependencies under vendor/ Modifications: - [import] replace the current parser with a generic, stable parser - move code to application/NetscapeBookmarkUtils - improve status report after parsing - [router] use the same endpoint for both bookmark upload and import dialog - [template] update bookmark import options - allow adding tags to all imported links - allow selecting the visibility (privacy) of imported links - [tests] ensure bookmarks are properly parsed and imported in the LinkDB - reuse reference input from the parser's test data See: - https://github.com/shaarli/netscape-bookmark-parser - https://getcomposer.org/doc/01-basic-usage.md#autoloading Signed-off-by: VirtualTam <virtualtam@flibidi.net>

Relates to #607 Relates to #608 Modifications: - match the arborescence of the archives provided by GitHub - generate compressed tarballs Signed-off-by: VirtualTam <virtualtam@flibidi.net>

Relates to shaarli#607 Relates to shaarli#608 Relates to shaarli#493 (abandoned) Additions: - use Composer's autoload to load 3rd-party dependencies under vendor/ Modifications: - [import] replace the current parser with a generic, stable parser - move code to application/NetscapeBookmarkUtils - improve status report after parsing - [router] use the same endpoint for both bookmark upload and import dialog - [template] update bookmark import options - allow adding tags to all imported links - allow selecting the visibility (privacy) of imported links - [tests] ensure bookmarks are properly parsed and imported in the LinkDB - reuse reference input from the parser's test data See: - https://github.com/shaarli/netscape-bookmark-parser - https://getcomposer.org/doc/01-basic-usage.md#autoloading Signed-off-by: VirtualTam <virtualtam@flibidi.net>

Relates to shaarli#607 Relates to shaarli#608 Modifications: - match the arborescence of the archives provided by GitHub - generate compressed tarballs Signed-off-by: VirtualTam <virtualtam@flibidi.net>

Composer: add shaarli/netscape-bookmark-parser

7f5ab8c

Relates to shaarli#607 Relates to kafene/netscape-bookmark-parser#6 The Shaarli-forked version is checked out as a VCS repository. Signed-off-by: VirtualTam <virtualtam@flibidi.net>

virtualtam added enhancement in progress tools developer tools 3rd party interoperability with third-party platforms labels Jul 23, 2016

virtualtam added this to the 0.8.0 milestone Jul 23, 2016

virtualtam self-assigned this Jul 23, 2016

ArthurHoaro reviewed Jul 25, 2016
View reviewed changes

virtualtam force-pushed the refactor/bookmark-parser branch from 9860d31 to c6662f6 Compare July 25, 2016 20:04

virtualtam added in review and removed in progress labels Jul 25, 2016

virtualtam mentioned this pull request Jul 25, 2016

Introduce a generic Netscape bookmark parser #607

Closed

18 tasks

virtualtam force-pushed the refactor/bookmark-parser branch from c6662f6 to 559315b Compare July 25, 2016 21:54

virtualtam removed the in review label Jul 26, 2016

virtualtam merged commit efc0c86 into shaarli:master Jul 26, 2016

virtualtam mentioned this pull request Jul 28, 2016

Refactor bookmark import using a generic Netscape parser #612

Merged

virtualtam mentioned this pull request Jul 28, 2016

Use Composer to manage all 3rd-party PHP libraries #613

Closed

3 tasks

virtualtam mentioned this pull request Aug 16, 2016

Latest commits broke Shaarli #639

Closed

virtualtam mentioned this pull request Oct 16, 2016

Update release archive generation #661

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reference netscape-bookmark-parser & allow generating custom release archives #608

Reference netscape-bookmark-parser & allow generating custom release archives #608

virtualtam commented Jul 23, 2016

ArthurHoaro Jul 25, 2016

virtualtam Jul 25, 2016

ArthurHoaro Jul 25, 2016

ArthurHoaro commented Jul 25, 2016 •

edited

Loading

virtualtam commented Jul 25, 2016

virtualtam commented Jul 25, 2016

nodiscc commented Jul 25, 2016 •

edited

Loading

virtualtam commented Jul 25, 2016

alexisju commented Aug 17, 2016

nodiscc commented Aug 17, 2016 •

edited

Loading

alexisju commented Aug 17, 2016

nodiscc commented Aug 17, 2016 •

edited

Loading

virtualtam commented Aug 17, 2016

ArthurHoaro commented Oct 14, 2016

virtualtam commented Oct 14, 2016

virtualtam commented Oct 16, 2016

Reference netscape-bookmark-parser & allow generating custom release archives #608

Reference netscape-bookmark-parser & allow generating custom release archives #608

Conversation

virtualtam commented Jul 23, 2016

ArthurHoaro Jul 25, 2016

Choose a reason for hiding this comment

virtualtam Jul 25, 2016

Choose a reason for hiding this comment

ArthurHoaro Jul 25, 2016

Choose a reason for hiding this comment

ArthurHoaro commented Jul 25, 2016 • edited Loading

virtualtam commented Jul 25, 2016

virtualtam commented Jul 25, 2016

nodiscc commented Jul 25, 2016 • edited Loading

virtualtam commented Jul 25, 2016

alexisju commented Aug 17, 2016

nodiscc commented Aug 17, 2016 • edited Loading

alexisju commented Aug 17, 2016

nodiscc commented Aug 17, 2016 • edited Loading

virtualtam commented Aug 17, 2016

ArthurHoaro commented Oct 14, 2016

virtualtam commented Oct 14, 2016

virtualtam commented Oct 16, 2016

ArthurHoaro commented Jul 25, 2016 •

edited

Loading

nodiscc commented Jul 25, 2016 •

edited

Loading

nodiscc commented Aug 17, 2016 •

edited

Loading

nodiscc commented Aug 17, 2016 •

edited

Loading