[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[EP-tech] GitHub - an action to create an EPM from an EMPI manifest
Hi John and others,
I have no objection to making this change. Anything that assists
deploying new versions of Bazaar plugins when new functionality or
important bug fixes need to be made available has to be a good thing.?
Obviously, the important thing is not make sure this cannot be easily
abused to add erroneous or malicious new versions of plugins to the
Bazaar.? A while back I modified the Bazaar so only admins, editors and
approved_users can immediately put new (versions of) Bazaar plugins
live.? Otherwise, they go for review.
I think for Altmetric and other commonly used plugins it would be good
to co-ordinate custodians for their GitHub repository.? Ideally these
custodians, would also be willing to review and merge pull requests and
publish new versions of the plugins (to the Bazaar) when appropriate and
maybe even do some development themselves.? With a set of custodians
across these plugin GitHub repositories we could then hopefully agree on
some common practice for their maintenance, versioning and publishing to
the Bazaar.? I am happy to be the custodian (or maybe a secondary
custodian) for some plugins, if I feel I am sufficiently knowledgable.
Regards
David Newman
On 16/09/2022 11:59 am, John Salter via Eprints-tech wrote:
> *CAUTION:* This e-mail originated outside the University of Southampton.
> Hi,
> TL;DR: would 'we' be happy for me to create a GitHub marketplace
> action under the 'eprintsug' account which creates EPM packages from
> GitHub repos?
>
> The details:
> I've been having a bit of an experiment with GitHub actions, in
> relation to EPrints packages.
> In an experimental fork of the Altmetric plugin, I have added an
> action that automatically creates a pull-request containing the EPM
> file generated from the most recent updates to the master branch e.g.
> https://eur03.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fjesusbagpuss%2Faltmetric%2Fpull%2F1&data=05%7C01%7Ceprints-tech%40ecs.soton.ac.uk%7Cbe78b06eeaf84e1554ce08da97df7de4%7C4a5378f929f44d3ebe89669d03ada9d8%7C0%7C0%7C637989283380320148%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=ikhBZHsBjUpXLl9%2Bx88uB7%2BQsc8tH77m19hbKLB3YZw%3D&reserved=0
> <https://eur03.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fjesusbagpuss%2Faltmetric%2Fpull%2F1&data=05%7C01%7Ceprints-tech%40ecs.soton.ac.uk%7Cbe78b06eeaf84e1554ce08da97df7de4%7C4a5378f929f44d3ebe89669d03ada9d8%7C0%7C0%7C637989283380320148%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=ikhBZHsBjUpXLl9%2Bx88uB7%2BQsc8tH77m19hbKLB3YZw%3D&reserved=0>
>
> The action is currently part of the above fork and consists of
> (https://eur03.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fjesusbagpuss%2Faltmetric%2Ftree%2Fmaster%2F.github%2Fworkflows&data=05%7C01%7Ceprints-tech%40ecs.soton.ac.uk%7Cbe78b06eeaf84e1554ce08da97df7de4%7C4a5378f929f44d3ebe89669d03ada9d8%7C0%7C0%7C637989283380320148%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=B5ObMWwC9%2BeR0Pxk9Z1jZxxPpl93rXeJXzKGbpKZca4%3D&reserved=0
> <https://eur03.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fjesusbagpuss%2Faltmetric%2Ftree%2Fmaster%2F.github%2Fworkflows&data=05%7C01%7Ceprints-tech%40ecs.soton.ac.uk%7Cbe78b06eeaf84e1554ce08da97df7de4%7C4a5378f929f44d3ebe89669d03ada9d8%7C0%7C0%7C637989283380476362%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=SS%2BtVA8cfr5lR%2B1UUxqu%2FfWTntjE22wWIpdgdeGrotQ%3D&reserved=0>):
> - a yaml file describing the action itself
> - a perl script that checks the EPMI file; files present in the repo,
> and then builds the EPM
>
> I had pondered a more extensive action, that would have created a
> working EPrints instance, and created the epm using normal EPrints
> tooling. Whilst I think this is achievable and may be useful for
> testing that an updated plugin was working as expected (especially if
> it included some tests to run), I was looking for a quick way to
> create the package file itself.
>
> Do people think this is a useful approach/tool?
> If so, I think I can create a GitHub marketplace action from the
> eprintsug organisation which could be run against any plugin.
>
> You can see the output of a 'build_epm' action here:
> https://eur03.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fjesusbagpuss%2Faltmetric%2Factions%2Fruns%2F3056341547%2Fjobs%2F4930402347&data=05%7C01%7Ceprints-tech%40ecs.soton.ac.uk%7Cbe78b06eeaf84e1554ce08da97df7de4%7C4a5378f929f44d3ebe89669d03ada9d8%7C0%7C0%7C637989283380476362%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=hfaeNzZRzOjX7rx%2BH7JZv8KDMld2k0nrOMLjzSp1sNY%3D&reserved=0
> <https://eur03.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fjesusbagpuss%2Faltmetric%2Factions%2Fruns%2F3056341547%2Fjobs%2F4930402347&data=05%7C01%7Ceprints-tech%40ecs.soton.ac.uk%7Cbe78b06eeaf84e1554ce08da97df7de4%7C4a5378f929f44d3ebe89669d03ada9d8%7C0%7C0%7C637989283380476362%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=hfaeNzZRzOjX7rx%2BH7JZv8KDMld2k0nrOMLjzSp1sNY%3D&reserved=0>
> Under the 'Build EPM' section you can see an example of warnings
> generated when a file exists in the git repository but isn't
> referenced in the EMPI manifest.
>
> The build script will fail if e.g. there isn't an EPMI file or if
> there's more than one.
> It will produce warnings if files present in the repo aren't listed in
> the EPMI (this may be legitimate - e.g. a README for the git repo).
> It will also produce a warning if a file referenced in the EPMI isn't
> in the git repo (this probably should create an error, and cause the
> build to fail).
> The generated EPMI file also includes a comment about it being
> auto-built:
> https://eur03.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fjesusbagpuss%2Faltmetric%2Fblob%2Fautobuild-epm%2Faltmetric.epm%23L2-L3&data=05%7C01%7Ceprints-tech%40ecs.soton.ac.uk%7Cbe78b06eeaf84e1554ce08da97df7de4%7C4a5378f929f44d3ebe89669d03ada9d8%7C0%7C0%7C637989283380476362%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=sI0LQ00yQGQugk3XSYLzHyNS67A0zVKZ5Pji%2FONRl1U%3D&reserved=0
> <https://eur03.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fjesusbagpuss%2Faltmetric%2Fblob%2Fautobuild-epm%2Faltmetric.epm%23L2-L3&data=05%7C01%7Ceprints-tech%40ecs.soton.ac.uk%7Cbe78b06eeaf84e1554ce08da97df7de4%7C4a5378f929f44d3ebe89669d03ada9d8%7C0%7C0%7C637989283380476362%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=sI0LQ00yQGQugk3XSYLzHyNS67A0zVKZ5Pji%2FONRl1U%3D&reserved=0>
>
> There are a couple of improvements I need to make, but thought I'd
> share at this point to see what you reckon.
>
> Cheers,
> John
>
> PS New Almetric plugin available soon ?
>
> *** Options:http://mailman.ecs.soton.ac.uk/mailman/listinfo/eprints-tech
> *** Archive:https://eur03.safelinks.protection.outlook.com/?url=http%3A%2F%2Fwww.eprints.org%2Ftech.php%2F&data=05%7C01%7Ceprints-tech%40ecs.soton.ac.uk%7Cbe78b06eeaf84e1554ce08da97df7de4%7C4a5378f929f44d3ebe89669d03ada9d8%7C0%7C0%7C637989283380476362%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=O30Qg%2FsKU0BTpNz2yvR4i1z%2BI3vi1GfsTjdAbEJ8B7w%3D&reserved=0
> *** EPrints community wiki:https://eur03.safelinks.protection.outlook.com/?url=http%3A%2F%2Fwiki.eprints.org%2F&data=05%7C01%7Ceprints-tech%40ecs.soton.ac.uk%7Cbe78b06eeaf84e1554ce08da97df7de4%7C4a5378f929f44d3ebe89669d03ada9d8%7C0%7C0%7C637989283380476362%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=2j6G5Dhy%2BP%2FnU%2Bp609Nfg65wZf%2FW6b2varthUvL%2F9NI%3D&reserved=0
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mailman.ecs.soton.ac.uk/pipermail/eprints-tech/attachments/20220916/9d94fa52/attachment-0001.html