关闭

浏览器扩展

updatesw:检查和更新存储库的存档

这个方便的浏览器扩展允许您无缝地检查您正在浏览的存储库是否已存档并且在软件遗产中是最新的。

接分机

您可以通过单击您感兴趣的浏览器的图像来找到并安装updatesw扩展
                                     

了解颜色代码

浏览器右侧的颜色编码按钮包含有关存档状态的信息,并允许触发适当的操作,如下所示:

  • :所获得的副本是最新的,单击该按钮将在归档文件的相应页面上打开一个选项卡(如果您想获得一个SWHID permalink,则非常实用)
  • :存档副本不是最新的,单击该按钮会触发“立即保存代码”请求以更新存档;右键单击可进入上一个成功存档的页面
  • :存档副本不是最新的,上次尝试存档失败;单击该按钮会触发“立即保存代码”请求以更新存档,但可能存在一些技术问题,使该存储库目前无法存档;右键单击可转到上一个存档的页面,该页面可能失败
  • :在存档文件中找不到该存储库(至少不来自此源),单击该按钮将触发“立即保存代码”请求,首次对其进行存档
  • :您目前已用完您在SWH API或forge API上的API调用配额:请稍等片刻,然后重试,或获取令牌以提高速率限制(详细信息如下)
  • :对软件遗产的API请求未成功。这可能有以下几种原因:

工具提示会记住所有这些,所以你不需要记住上面的所有内容,它们还提供了额外的信息(例如,上次修改锻造炉和档案的日期)。

支持的代码托管平台

扩展支持现成的BitBucket、GitHub、GitLab。域名格式为的com和GitLab实例gitlab.**

您可以在选项面板中添加其他GitLab实例(见下文)。

未来可能会增加对其他代码托管平台和技术的支持。

时间延迟

当在存储库(例如,推送新的提交)或软件遗产归档(例如,存档中接收到存储库的(新版本)中)中发生更改时,事件可能需要一段时间才能显示在API中。在软件遗产方面,这通常是几分钟的事情,但在一些代码托管平台上,我们已经看到了几个小时的延迟。

为了确定要显示的正确颜色,扩展调用代码宿主API以获取存储库的上次更新日期,并调用软件遗产API获取最新存档的日期,因此显示的颜色确实反映了这些API公开的内容,但这可能暂时不是实际状态。

选择你的选择

可以通过单击打开选项面板图标在浏览器栏中(如果不在栏中,请在活动扩展列表中查找)。

这允许您选择是否启用以下选项:

  • 显示保存请求:如果选中此选项,则当您通过单击黄色或灰色按钮发出保存请求时,通知扩展打开一个新的选项卡来检查保存请求(当该按钮变为浅绿色时,您仍然可以通过单击该按钮来访问同一页)。
  • SWH调试模式:如果选中,有关扩展的详细信息将记录在浏览器的控制台中(通常通过F12访问);这对调试很有用,除非你需要,否则不要打开它
  • GitHub API访问令牌:此文本区域允许您粘贴一个GitHubAPI访问令牌,如果您使用了标准的GitHub API请求配额(这相当低:每30分钟只请求60个请求),则非常有用橙色过了一会儿,这是你的案子:请跟我来GitHub指令并创建新的令牌 (不要授予它任何权利,扩展不需要它们!) 贴在这里。
  • SWH API访问令牌:此文本区域允许您粘贴你的SWH API访问令牌,如果您用完了标准API请求配额。如果你的按钮开始橙色过了一会儿,这是你的案子:拜托登录或注册软件遗产档案首先,然后为您的扩展创建访问令牌贴在这里。
  • 其他GitLab实例:在这里添加您希望扩展识别的其他GitLab实例的域名。每行一个域名,没有前缀或后缀(例如:写“src.koda.cnrs.fr”,而不是“https://src.koda.cnrs.fr/“,见图片)。

注意:如果在文本字段中粘贴垃圾,扩展将无法正常工作!如果有疑问,请选择文本区域的所有内容,将其删除以恢复正常操作,然后重试。

为什么安装警告“此扩展要求访问所有网站上的数据”?

当您第一次安装扩展时,您会看到一条警告,内容如下:此扩展要求访问所有网站上的数据“让我们解释一下这条信息的含义和原因在这种情况下你不应该被它吓到.

这个更新wh延伸需要访问一个软件伪造网站的源代码有两个原因:

  1. 添加彩色按钮作为添加到DOM的'<div>'元素
  2. 监视对URL的更改当网站在幕后操纵DOM时的网页(例如GitHub)

不幸的是,没有办法具体说明updatesw仅执行此操作,所以我们需要使用匹配指令其中包含扩展运行的脚本的“<any\u url>”,这将触发警告消息。

为了得到一个不那么可怕的消息,我们可以限制对已知代码托管平台的访问,但这意味着阻止您在您选择的平台上使用扩展(有成千上万个GitLab实例!)。

所以,为了给你更多的功能,我们决定使用可怕的信息,但是你可以签入源代码没有什么可疑之处(我们不使用javascript蒸馏器或代码混淆器,您可以阅读评论).

贡献

这个扩展是开放源码的,根据麻省理工学院的许可条款进行分发。源代码位于开发存储库。欢迎投稿。