diff --git a/a11y-dark.css b/a11y-dark.css new file mode 100644 index 00000000..b93b742a --- /dev/null +++ b/a11y-dark.css @@ -0,0 +1,99 @@ +/* a11y-dark theme */ +/* Based on the Tomorrow Night Eighties theme: https://github.com/isagalaev/highlight.js/blob/master/src/styles/tomorrow-night-eighties.css */ +/* @author: ericwbailey */ + +/* Comment */ +.hljs-comment, +.hljs-quote { + color: #d4d0ab; +} + +/* Red */ +.hljs-variable, +.hljs-template-variable, +.hljs-tag, +.hljs-name, +.hljs-selector-id, +.hljs-selector-class, +.hljs-regexp, +.hljs-deletion { + color: #ffa07a; +} + +/* Orange */ +.hljs-number, +.hljs-built_in, +.hljs-builtin-name, +.hljs-literal, +.hljs-type, +.hljs-params, +.hljs-meta, +.hljs-link { + color: #f5ab35; +} + +/* Yellow */ +.hljs-attribute { + color: #ffd700; +} + +/* Green */ +.hljs-string, +.hljs-symbol, +.hljs-bullet, +.hljs-addition { + color: #abe338; +} + +/* Blue */ +.hljs-title, +.hljs-section { + color: #00e0e0; +} + +/* Purple */ +.hljs-keyword, +.hljs-selector-tag { + color: #dcc6e0; +} + +.hljs { + display: block; + overflow-x: auto; + background: #2b2b2b; + color: #f8f8f2; + padding: 0.5em; +} + +.hljs-emphasis { + font-style: italic; +} + +.hljs-strong { + font-weight: bold; +} + +@media screen and (-ms-high-contrast: active) { + .hljs-addition, + .hljs-attribute, + .hljs-built_in, + .hljs-builtin-name, + .hljs-bullet, + .hljs-comment, + .hljs-link, + .hljs-literal, + .hljs-meta, + .hljs-number, + .hljs-params, + .hljs-string, + .hljs-symbol, + .hljs-type, + .hljs-quote { + color: highlight; + } + + .hljs-keyword, + .hljs-selector-tag { + font-weight: bold; + } +} diff --git a/a11y-light.css b/a11y-light.css new file mode 100644 index 00000000..f1bf8f3f --- /dev/null +++ b/a11y-light.css @@ -0,0 +1,99 @@ +/* a11y-light theme */ +/* Based on the Tomorrow Night Eighties theme: https://github.com/isagalaev/highlight.js/blob/master/src/styles/tomorrow-night-eighties.css */ +/* @author: ericwbailey */ + +/* Comment */ +.hljs-comment, +.hljs-quote { + color: #696969; +} + +/* Red */ +.hljs-variable, +.hljs-template-variable, +.hljs-tag, +.hljs-name, +.hljs-selector-id, +.hljs-selector-class, +.hljs-regexp, +.hljs-deletion { + color: #d91e18; +} + +/* Orange */ +.hljs-number, +.hljs-built_in, +.hljs-builtin-name, +.hljs-literal, +.hljs-type, +.hljs-params, +.hljs-meta, +.hljs-link { + color: #aa5d00; +} + +/* Yellow */ +.hljs-attribute { + color: #aa5d00; +} + +/* Green */ +.hljs-string, +.hljs-symbol, +.hljs-bullet, +.hljs-addition { + color: #008000; +} + +/* Blue */ +.hljs-title, +.hljs-section { + color: #007faa; +} + +/* Purple */ +.hljs-keyword, +.hljs-selector-tag { + color: #7928a1; +} + +.hljs { + display: block; + overflow-x: auto; + background: #fefefe; + color: #545454; + padding: 0.5em; +} + +.hljs-emphasis { + font-style: italic; +} + +.hljs-strong { + font-weight: bold; +} + +@media screen and (-ms-high-contrast: active) { + .hljs-addition, + .hljs-attribute, + .hljs-built_in, + .hljs-builtin-name, + .hljs-bullet, + .hljs-comment, + .hljs-link, + .hljs-literal, + .hljs-meta, + .hljs-number, + .hljs-params, + .hljs-string, + .hljs-symbol, + .hljs-type, + .hljs-quote { + color: highlight; + } + + .hljs-keyword, + .hljs-selector-tag { + font-weight: bold; + } +} diff --git a/batch-updates/index.html b/batch-updates/index.html new file mode 100644 index 00000000..48d0980a --- /dev/null +++ b/batch-updates/index.html @@ -0,0 +1,4309 @@ + + + + + + + + + + + + + + Batch updates | nixpkgs-update + + + +
+
+ +
+ + +
+
+

+Batch updates +

+

nixpkgs-update supports batch updates via the update-list +subcommand.

+

Update-List tutorial

+
    +
  1. +

    Setup hub and give it your GitHub +credentials, so it saves an oauth token. This allows nixpkgs-update +to query the GitHub API. Alternatively, if you prefer not to install +and configure hub, you can manually create a GitHub token with +repo and gist scopes. Provide it to nixpkgs-update by +exporting it as the GITHUB_TOKEN environment variable +(nixpkgs-update reads credentials from the files hub uses but +no longer uses hub itself).

    +
    2. +
  2. +

    Clone this repository and build nixpkgs-update:

    +
    git clone https://github.com/ryantm/nixpkgs-update && cd nixpkgs-update
+nix-build
+
    +
    3. +
  3. +

    To test your config, try to update a single package, like this:

    +
    ./result/bin/nixpkgs-update update "pkg oldVer newVer update-page"`
+
+# Example:
+./result/bin/nixpkgs-update update "tflint 0.15.0 0.15.1 repology.org"`
+
    +

    replacing tflint with the attribute name of the package you actually want +to update, and the old version and new version accordingly.

    +

    If this works, you are now setup to hack on nixpkgs-update! If +you run it with --pr, it will actually send a pull request, which +looks like this: https://github.com/NixOS/nixpkgs/pull/82465

    +
    4. +
  4. +

    If you'd like to send a batch of updates, get a list of outdated packages and +place them in a packages-to-update.txt file:

    +
    5. +
+
./result/bin/nixpkgs-update fetch-repology > packages-to-update.txt
+
+

There also exist alternative sources of updates, these include:

+ +
    +
  1. Run the tool in batch mode with update-list:
    2. +
+
./result/bin/nixpkgs-update update-list
+
+
+ +
+ + +
+ + diff --git a/contributing/index.html b/contributing/index.html new file mode 100644 index 00000000..e0c111d8 --- /dev/null +++ b/contributing/index.html @@ -0,0 +1,4277 @@ + + + + + + + + + + + + + + Contributing | nixpkgs-update + + + +
+
+ +
+ + +
+
+

+Contributing +

+

Incremental development:

+
nix-shell --run "cabal v2-repl"
+
+

Run the tests:

+
nix-shell --run "cabal v2-test"
+
+

Run a type checker in the background for quicker type checking feedback:

+
nix-shell --run "ghcid"
+
+

Run a type checker for the app code:

+
nix-shell --run 'ghcid -c "cabal v2-repl exe:nixpkgs-update"'
+
+

Run a type checker for the test code:

+
nix-shell --run 'ghcid -c "cabal v2-repl tests"'
+
+

Updating the Cabal file when adding new dependencies or options:

+
nix run nixpkgs#haskellPackages.hpack
+
+

Source files are formatted with Ormolu.

+

There is also a Cachix cache available for the dependencies of this program.

+
+ +
+ + +
+ + diff --git a/details/index.html b/details/index.html new file mode 100644 index 00000000..455c1eb1 --- /dev/null +++ b/details/index.html @@ -0,0 +1,4308 @@ + + + + + + + + + + + + + + Details | nixpkgs-update + + + +
+
+ +
+ + +
+
+

+Details +

+

Some of these features only apply to the update-list sub-command or to +features only available to the @r-ryantm bot.

+

Checks

+

A number of checks are performed to help nixpkgs maintainers gauge the +likelihood that an update was successful. All the binaries are run with +various flags to see if they have a zero exit code and output the new +version number. The outpath directory tree is searched for files +containing the new version number. A directory tree and disk usage +listing is provided.

+

Security report

+

Information from the National Vulnerability Database maintained by +NIST is compared against the current and updated package version. The +nixpkgs package name is matched with the Common Platform Enumeration +vendor, product, edition, software edition, and target software fields +to find candidate Common Vulnerabilities and Exposures (CVEs). The +CVEs are filtered by the matching the current and updated versions +with the CVE version ranges.

+

The general philosophy of the CVE search is to avoid false negatives, +which means we expect to generate many false positives. The false +positives can be carefully removed by manually created rules +implemented in the filter function in the NVDRules module.

+

If there are no CVE matches, the report is not shown. The report has +three parts: CVEs resolved by this update, CVEs introduced by this +update, and CVEs present in both version.

+

If you would like to report a problem with the security report, please +use the nixpkgs-update GitHub +issues.

+

The initial development of the security report was made possible by a +partnership with Serokell and the NLNet +Foundation through their Next Generation Internet +Zero Discovery initiative (NGI0 +Discovery). NGI0 Discovery is made possible with financial support +from the European Commission.

+

Rebuild report

+

The PRs made by nixpkgs-update say what packages need to be rebuilt if +the pull request is merged. This uses the same mechanism +OfBorg uses to put rebuild labels +on PRs. Not limited by labels, it can report the exact number of +rebuilds and list some of the attrpaths that would need to be rebuilt.

+

PRs against staging

+

If a PR merge would cause more than 500 packages to be rebuilt, the PR +is made against staging.

+

Logs

+

Logs from r-ryantm's runs are +available online. There are a lot of packages nixpkgs-update +currently has no hope of updating. Please dredge the logs to find out +why your pet package is not receiving updates.

+

Cachix

+

By uploading the build outputs to +Cachix, nixpkgs-update allows you to +test a package with one command.

+
+ +
+ + +
+ + diff --git a/donate/index.html b/donate/index.html new file mode 100644 index 00000000..84e34718 --- /dev/null +++ b/donate/index.html @@ -0,0 +1,4262 @@ + + + + + + + + + + + + + + Donate | nixpkgs-update + + + +
+
+ +
+ + +
+
+

+Donate +

+

@r-ryantm, the bot that updates Nixpkgs, is currently running on a Hetzner bare-metal server that costs me €60 per month. Your support in paying for infrastructure would be a great help:

+ +
+ +
+ + +
+ + diff --git a/fuse.basic.min.js b/fuse.basic.min.js new file mode 100644 index 00000000..89477c64 --- /dev/null +++ b/fuse.basic.min.js @@ -0,0 +1,9 @@ +/** + * Fuse.js v6.6.2 - Lightweight fuzzy-search (http://fusejs.io) + * + * Copyright (c) 2022 Kiro Risk (http://kiro.me) + * All Rights Reserved. Apache Software License 2.0 + * + * http://www.apache.org/licenses/LICENSE-2.0 + */ +var e,t;e=this,t=function(){"use strict";function e(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function t(t){for(var n=1;ne.length)&&(t=e.length);for(var n=0,r=new Array(t);n0&&void 0!==arguments[0]?arguments[0]:1,t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:3,n=new Map,r=Math.pow(10,t);return{get:function(t){var i=t.match(_).length;if(n.has(i))return n.get(i);var o=1/Math.pow(i,.5*e),a=parseFloat(Math.round(o*r)/r);return n.set(i,a),a},clear:function(){n.clear()}}}var O=function(){function e(){var t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{},n=t.getFn,i=void 0===n?L.getFn:n,o=t.fieldNormWeight,a=void 0===o?L.fieldNormWeight:o;r(this,e),this.norm=S(a,3),this.getFn=i,this.isCreated=!1,this.setIndexRecords()}return o(e,[{key:"setSources",value:function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:[];this.docs=e}},{key:"setIndexRecords",value:function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:[];this.records=e}},{key:"setKeys",value:function(){var e=this,t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:[];this.keys=t,this._keysMap={},t.forEach((function(t,n){e._keysMap[t.id]=n}))}},{key:"create",value:function(){var e=this;!this.isCreated&&this.docs.length&&(this.isCreated=!0,u(this.docs[0])?this.docs.forEach((function(t,n){e._addString(t,n)})):this.docs.forEach((function(t,n){e._addObject(t,n)})),this.norm.clear())}},{key:"add",value:function(e){var t=this.size();u(e)?this._addString(e,t):this._addObject(e,t)}},{key:"removeAt",value:function(e){this.records.splice(e,1);for(var t=e,n=this.size();t2&&void 0!==arguments[2]?arguments[2]:{},r=n.getFn,i=void 0===r?L.getFn:r,o=n.fieldNormWeight,a=void 0===o?L.fieldNormWeight:o,c=new O({getFn:i,fieldNormWeight:a});return c.setKeys(e.map(k)),c.setSources(t),c.create(),c}function j(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{},n=t.errors,r=void 0===n?0:n,i=t.currentLocation,o=void 0===i?0:i,a=t.expectedLocation,c=void 0===a?0:a,s=t.distance,h=void 0===s?L.distance:s,u=t.ignoreLocation,l=void 0===u?L.ignoreLocation:u,d=r/e.length;if(l)return d;var f=Math.abs(c-o);return h?d+f/h:f?1:d}function E(){for(var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:[],t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:L.minMatchCharLength,n=[],r=-1,i=-1,o=0,a=e.length;o=t&&n.push([r,i]),r=-1)}return e[o-1]&&o-r>=t&&n.push([r,o-1]),n}var I=32;function F(e){for(var t={},n=0,r=e.length;n1&&void 0!==arguments[1]?arguments[1]:{},o=i.location,a=void 0===o?L.location:o,c=i.threshold,s=void 0===c?L.threshold:c,h=i.distance,u=void 0===h?L.distance:h,l=i.includeMatches,d=void 0===l?L.includeMatches:l,f=i.findAllMatches,v=void 0===f?L.findAllMatches:f,g=i.minMatchCharLength,y=void 0===g?L.minMatchCharLength:g,p=i.isCaseSensitive,m=void 0===p?L.isCaseSensitive:p,b=i.ignoreLocation,k=void 0===b?L.ignoreLocation:b;if(r(this,e),this.options={location:a,threshold:s,distance:u,includeMatches:d,findAllMatches:v,minMatchCharLength:y,isCaseSensitive:m,ignoreLocation:k},this.pattern=m?t:t.toLowerCase(),this.chunks=[],this.pattern.length){var M=function(e,t){n.chunks.push({pattern:e,alphabet:F(e),startIndex:t})},w=this.pattern.length;if(w>I){for(var x=0,_=w%I,S=w-_;x3&&void 0!==arguments[3]?arguments[3]:{},i=r.location,o=void 0===i?L.location:i,a=r.distance,c=void 0===a?L.distance:a,s=r.threshold,h=void 0===s?L.threshold:s,u=r.findAllMatches,l=void 0===u?L.findAllMatches:u,d=r.minMatchCharLength,f=void 0===d?L.minMatchCharLength:d,v=r.includeMatches,g=void 0===v?L.includeMatches:v,y=r.ignoreLocation,m=void 0===y?L.ignoreLocation:y;if(t.length>I)throw new Error(p(I));for(var b,k=t.length,M=e.length,w=Math.max(0,Math.min(o,M)),x=h,_=w,S=f>1||g,O=S?Array(M):[];(b=e.indexOf(t,_))>-1;){var A=j(t,{currentLocation:b,expectedLocation:w,distance:c,ignoreLocation:m});if(x=Math.min(A,x),_=b+k,S)for(var F=0;F=T;R-=1){var U=R-1,B=n[e.charAt(U)];if(S&&(O[U]=+!!B),J[R]=(J[R+1]<<1|1)&B,$&&(J[R]|=(C[R+1]|C[R])<<1|1|C[R+1]),J[R]&W&&(N=j(t,{errors:$,currentLocation:U,expectedLocation:w,distance:c,ignoreLocation:m}))<=x){if(x=N,(_=U)<=w)break;T=Math.max(1,2*w-_)}}if(j(t,{errors:$+1,currentLocation:w,expectedLocation:w,distance:c,ignoreLocation:m})>x)break;C=J}var V={isMatch:_>=0,score:Math.max(.001,N)};if(S){var q=E(O,f);q.length?g&&(V.indices=q):V.isMatch=!1}return V}(e,n,i,{location:a+o,distance:s,threshold:h,findAllMatches:u,minMatchCharLength:l,includeMatches:r,ignoreLocation:d}),m=y.isMatch,b=y.score,k=y.indices;m&&(g=!0),v+=b,m&&k&&(f=[].concat(c(f),c(k)))}));var y={isMatch:g,score:g?v/this.chunks.length:1};return g&&r&&(y.indices=f),y}}]),e}(),N=[];function P(e,t){for(var n=0,r=N.length;n-1&&(n.refIndex=e.idx),t.matches.push(n)}}))}function D(e,t){t.score=e.score}function K(e,t){var n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:{},r=n.includeMatches,i=void 0===r?L.includeMatches:r,o=n.includeScore,a=void 0===o?L.includeScore:o,c=[];return i&&c.push($),a&&c.push(D),e.map((function(e){var n=e.idx,r={item:t[n],refIndex:n};return c.length&&c.forEach((function(t){t(e,r)})),r}))}var T=function(){function e(n){var i=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{},o=arguments.length>2?arguments[2]:void 0;if(r(this,e),this.options=t(t({},L),i),this.options.useExtendedSearch)throw new Error(y);this._keyStore=new b(this.options.keys),this.setCollection(n,o)}return o(e,[{key:"setCollection",value:function(e,t){if(this._docs=e,t&&!(t instanceof O))throw new Error("Incorrect 'index' type");this._myIndex=t||A(this.options.keys,this._docs,{getFn:this.options.getFn,fieldNormWeight:this.options.fieldNormWeight})}},{key:"add",value:function(e){f(e)&&(this._docs.push(e),this._myIndex.add(e))}},{key:"remove",value:function(){for(var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:function(){return!1},t=[],n=0,r=this._docs.length;n1&&void 0!==arguments[1]?arguments[1]:{},n=t.limit,r=void 0===n?-1:n,i=this.options,o=i.includeMatches,a=i.includeScore,c=i.shouldSort,s=i.sortFn,h=i.ignoreFieldNorm,d=u(e)?u(this._docs[0])?this._searchStringList(e):this._searchObjectList(e):this._searchLogical(e);return W(d,{ignoreFieldNorm:h}),c&&d.sort(s),l(r)&&r>-1&&(d=d.slice(0,r)),K(d,this._docs,{includeMatches:o,includeScore:a})}},{key:"_searchStringList",value:function(e){var t=P(e,this.options),n=this._myIndex.records,r=[];return n.forEach((function(e){var n=e.v,i=e.i,o=e.n;if(f(n)){var a=t.searchIn(n),c=a.isMatch,s=a.score,h=a.indices;c&&r.push({item:n,idx:i,matches:[{score:s,value:n,norm:o,indices:h}]})}})),r}},{key:"_searchLogical",value:function(e){throw new Error("Logical search is not available")}},{key:"_searchObjectList",value:function(e){var t=this,n=P(e,this.options),r=this._myIndex,i=r.keys,o=r.records,a=[];return o.forEach((function(e){var r=e.$,o=e.i;if(f(r)){var s=[];i.forEach((function(e,i){s.push.apply(s,c(t._findMatches({key:e,value:r[i],searcher:n})))})),s.length&&a.push({idx:o,item:r,matches:s})}})),a}},{key:"_findMatches",value:function(e){var t=e.key,n=e.value,r=e.searcher;if(!f(n))return[];var i=[];if(h(n))n.forEach((function(e){var n=e.v,o=e.i,a=e.n;if(f(n)){var c=r.searchIn(n),s=c.isMatch,h=c.score,u=c.indices;s&&i.push({score:h,key:t,value:n,idx:o,norm:a,indices:u})}}));else{var o=n.v,a=n.n,c=r.searchIn(o),s=c.isMatch,u=c.score,l=c.indices;s&&i.push({score:u,key:t,value:o,norm:a,indices:l})}return i}}]),e}();return T.version="6.6.2",T.createIndex=A,T.parseIndex=function(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{},n=t.getFn,r=void 0===n?L.getFn:n,i=t.fieldNormWeight,o=void 0===i?L.fieldNormWeight:i,a=e.keys,c=e.records,s=new O({getFn:r,fieldNormWeight:o});return s.setKeys(a),s.setIndexRecords(c),s},T.config=L,T},"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):(e="undefined"!=typeof globalThis?globalThis:e||self).Fuse=t(); \ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 00000000..b15a0902 --- /dev/null +++ b/index.html @@ -0,0 +1,4274 @@ + + + + + + + + + + + + + + nixpkgs-update | nixpkgs-update + + + +
+
+ +
+ + +
+
+

+nixpkgs-update +

+
+

The future is here; let's evenly distribute it!

+
+

The nixpkgs-update mission +is to make nixpkgs the most +up-to-date repository of software in the world by the most ridiculous +margin possible. Here's how we are doing so far.

+

It provides an interactive tool for automating single package +updates. Given a package name, old version, and new version, it +updates the version, and fetcher hashes, makes a commit, and +optionally a pull request. Along the way, it does checks to make sure +the update has a baseline quality.

+

It is the code used by the GitHub bot +@r-ryantm to automatically update +nixpkgs. It uses package repository information from +Repology.org, the +GitHub releases API, and PyPI to generate a lists of outdated +packages.

+
+ +
+ + +
+ + diff --git a/installation/index.html b/installation/index.html new file mode 100644 index 00000000..8e64a3c6 --- /dev/null +++ b/installation/index.html @@ -0,0 +1,4306 @@ + + + + + + + + + + + + + + Installation | nixpkgs-update + + + +
+
+ +
+ + +
+
+

+Installation +

+

Note

+

+For the Cachix cache to work, your user must be in the trusted-users +list or you can use sudo since root is effectively trusted. +

+
+

Run without installing on stable Nix:

+
$ nix run \
+  --option extra-substituters 'https://nixpkgs-update.cachix.org/' \
+  --option extra-trusted-public-keys 'nixpkgs-update.cachix.org-1:6y6Z2JdoL3APdu6/+Iy8eZX2ajf09e4EE9SnxSML1W8=' \
+  -f https://github.com/ryantm/nixpkgs-update/archive/main.tar.gz \
+  -c nixpkgs-update --help
+
+

Run without installing on unstable Nix with nix command enabled:

+
$ nix shell \
+  --option extra-substituters 'https://nixpkgs-update.cachix.org/' \
+  --option extra-trusted-public-keys 'nixpkgs-update.cachix.org-1:6y6Z2JdoL3APdu6/+Iy8eZX2ajf09e4EE9SnxSML1W8=' \
+  -f https://github.com/ryantm/nixpkgs-update/archive/main.tar.gz \
+  -c nixpkgs-update --help
+
+

Run without installing on unstable Nix with nix flakes enabled:

+
$ nix run \
+  --option extra-substituters 'https://nixpkgs-update.cachix.org/' \
+  --option extra-trusted-public-keys 'nixpkgs-update.cachix.org-1:6y6Z2JdoL3APdu6/+Iy8eZX2ajf09e4EE9SnxSML1W8=' \
+  github:ryantm/nixpkgs-update -- --help
+
+

Install into your Nix profile:

+
$ nix-env \
+  --option extra-substituters 'https://nixpkgs-update.cachix.org/' \
+  --option extra-trusted-public-keys 'nixpkgs-update.cachix.org-1:6y6Z2JdoL3APdu6/+Iy8eZX2ajf09e4EE9SnxSML1W8=' \
+  -if https://github.com/ryantm/nixpkgs-update/archive/main.tar.gz
+
+

Declaratively with niv:

+
$ niv add ryantm/nixpkgs-update
+
+

NixOS config with Niv:

+
let
+  sources = import ./nix/sources.nix;
+  nixpkgs-update = import sources.nixpkgs-update {};
+in
+  environment.systemPackages = [ nixpkgs-update ];
+
+

home-manager config with Niv:

+
let
+  sources = import ./nix/sources.nix;
+  nixpkgs-update = import sources.nixpkgs-update {};
+in
+  home.packages = [ nixpkgs-update ];
+
+
+ +
+ + +
+ + diff --git a/interactive-updates/index.html b/interactive-updates/index.html new file mode 100644 index 00000000..4ae5c604 --- /dev/null +++ b/interactive-updates/index.html @@ -0,0 +1,4299 @@ + + + + + + + + + + + + + + Interactive updates | nixpkgs-update + + + +
+
+ +
+ + +
+
+

+Interactive updates +

+

nixpkgs-update supports interactive, single package updates via the +update subcommand.

+

Update tutorial

+
    +
  1. Setup hub and give it your +GitHub credentials. Alternatively, if you prefer not to install +and configure hub, you can manually create a GitHub token with +repo and gist scopes. Provide it to nixpkgs-update by +exporting it as the GITHUB_TOKEN environment variable +(nixpkgs-update reads credentials from the files hub uses but +no longer uses hub itself).
    2. +
  2. Go to your local checkout of nixpkgs, and make sure the working +directory is clean. Be on a branch you are okay committing to.
    3. +
  3. Ensure that there is an Git origin called upstream which points to nixpkgs: +
    git remote add upstream "https://github.com/NixOS/nixpkgs.git"
+
    +
    4. +
  4. Run it like: nixpkgs-update update "postman 7.20.0 7.21.2" +which mean update the package "postman" from version 7.20.0 +to version 7.21.2.
    5. +
  5. It will run the updater, and, if the update builds, it will commit +the update and output a message you could use for a pull request.
    6. +
+

Flags

+
+
+

--cve

+
+
+

adds CVE vulnerability reporting to the PR message. On +first invocation with this option, a CVE database is +built. Subsequent invocations will be much faster.

+
+
+

--nixpkgs-review

+
+
+

runs nixpkgs-review, +which tries to build all the packages that depend on the one being +updated and adds a report.

+
+ +
+ +
+ + +
+ + diff --git a/nixpkgs-maintainer-faq/index.html b/nixpkgs-maintainer-faq/index.html new file mode 100644 index 00000000..074b129a --- /dev/null +++ b/nixpkgs-maintainer-faq/index.html @@ -0,0 +1,4324 @@ + + + + + + + + + + + + + + Nixpkgs Maintainer FAQ | nixpkgs-update + + + +
+
+ +
+ + +
+
+

+Nixpkgs Maintainer FAQ +

+

@r-ryantm opened a PR for my package, what do I do?

+

Thanks for being a maintainer. Hopefully, @r-ryantm will be able to save you some time!

+
    +
  1. Review the PR diff, making sure this update makes sense +
      +
    • sometimes updates go backward or accidentally use a dev version
      • +
    +
    2. +
  2. Review upstream changelogs and commits
    3. +
  3. Follow the "Instructions to test this update" section of the PR to get the built program on your computer quickly
    4. +
  4. Make a GitHub Review approving or requesting changes. Include screenshots or other notes as appropriate.
    5. +
+

+Why is @r-ryantm not updating my package? +

+

There are lots of reasons a package might not be updated. You can usually figure out which one is the issue by looking at the logs or by asking @ryantm on Matrix or GitHub.

+

No new version information

+

r-ryantm gets its new version information from three sources:

+
    +
  • Repology - information from Repology is delayed because it only updates when there is an unstable channel release
    • +
  • GitHub releases
    • +
  • PyPi releases
    • +
+

If none of these sources says the package is out of date, it will not attempt to update it.

+

Skiplist

+

We maintain a Skiplist of different things not to update. It is possible your package is triggering one of the skip criteria.

+

Python updates are skipped if they cause more than 25 rebuilds.

+

Existing Open or Draft PR

+

If there is an existing PR with the exact title of $attrPath: $oldVersion -> $newVersion, it will not update the package.

+

Version not newer

+

If Nix's builtins.compareVersions does not think the "new" version is newer, it will not update.

+

Incompatibile with "Path Pin"

+

Some attrpaths have versions appended to the end of them, like ruby_3_0, the new version has to be compatible with this "Path pin". Here are some examples:

+
-- >>> versionCompatibleWithPathPin "libgit2_0_25" "0.25.3"
+-- True
+--
+-- >>> versionCompatibleWithPathPin "owncloud90" "9.0.3"
+-- True
+--
+-- >>> versionCompatibleWithPathPin "owncloud-client" "2.4.1"
+-- True
+--
+-- >>> versionCompatibleWithPathPin "owncloud90" "9.1.3"
+-- False
+--
+-- >>> versionCompatibleWithPathPin "nodejs-slim-10_x" "11.2.0"
+-- False
+--
+-- >>> versionCompatibleWithPathPin "nodejs-slim-10_x" "10.12.0"
+-- True
+
+

Can't find derivation file

+

If nix edit $attrpath does not open the correct file that contains the version string and fetcher hash, the update will fail.

+

This might not work, for example, if a package doesn't have a meta attr (at all, or if the package uses a builder function that is discarding the meta attr).

+

Update already merged

+

If the update is already on master, staging, or staging-next, the update will fail.

+

Can't find hash or source url

+

If the derivation file has no hash or source URL, it will fail.

+

Since nixpkgs-update is trying to read these from <pkg>.src, this can also happen if the package's source is something unexpected such as another package. You can set the fallback originalSrc attr so that nixpkgs-update can find the correct source in cases like this.

+

No updateScript and no version

+

If the derivation file has no version and no updateScript, it will fail.

+

No changes

+

If the derivation "Rewriters" fail to change the derivation, it will fail.

+

If there is no updateScript, and the source url or the hash did not change, it will fail.

+

No rebuilds

+

If the rewrites didn't cause any derivations to change, it will fail.

+

Didn't build

+

If after the rewrites, it doesn't build, it will fail.

+
+ +
+ + +
+ + diff --git a/r-ryantm/index.html b/r-ryantm/index.html new file mode 100644 index 00000000..a9498650 --- /dev/null +++ b/r-ryantm/index.html @@ -0,0 +1,4258 @@ + + + + + + + + + + + + + + r-ryantm | nixpkgs-update + + + +
+
+ +
+ + +
+
+

+r-ryantm +

+

@r-ryantm, is a bot account that updates Nixpkgs by making PRs that bump a package to the latest version. It runs on community-configured infrastructure.

+
+ +
+ + +
+ + diff --git a/search_index.js b/search_index.js new file mode 100644 index 00000000..68573bcf --- /dev/null +++ b/search_index.js @@ -0,0 +1,10 @@ +const corpus = [{ "url": ".\/", "title": "nixpkgs-update", "text": "nixpkgs-updateThe future is here; let's evenly distribute it!\n\nThe nixpkgs-update mission is to make nixpkgs the most up-to-date repository of software in the world by the most\nridiculous margin possible. Here's how we are doing so far.\n\nIt provides an interactive tool for automating single package updates. Given a package name, old version, and new\nversion, it updates the version, and fetcher hashes, makes a commit, and optionally a pull request. Along the way, it\ndoes checks to make sure the update has a baseline quality.\n\nIt is the code used by the GitHub bot @r-ryantm to automatically update nixpkgs. It uses package repository information\nfrom Repology.org, the GitHub releases API, and PyPI to generate a lists of outdated packages.\n" } +,{ "url": "installation\/", "title": "Installation", "text": "Installation For the Cachix cache to work, your user must be in the trusted-users list or you can use sudo since root is\neffectively trusted. \n\nRun without installing on stable Nix:\n\n$ nix run \\\n --option extra-substituters 'https:\/\/nixpkgs-update.cachix.org\/' \\\n --option extra-trusted-public-keys 'nixpkgs-update.cachix.org-1:6y6Z2JdoL3APdu6\/+Iy8eZX2ajf09e4EE9SnxSML1W8=' \\\n -f https:\/\/github.com\/ryantm\/nixpkgs-update\/archive\/main.tar.gz \\\n -c nixpkgs-update --help\n\nRun without installing on unstable Nix with nix command enabled:\n\n$ nix shell \\\n --option extra-substituters 'https:\/\/nixpkgs-update.cachix.org\/' \\\n --option extra-trusted-public-keys 'nixpkgs-update.cachix.org-1:6y6Z2JdoL3APdu6\/+Iy8eZX2ajf09e4EE9SnxSML1W8=' \\\n -f https:\/\/github.com\/ryantm\/nixpkgs-update\/archive\/main.tar.gz \\\n -c nixpkgs-update --help\n\nRun without installing on unstable Nix with nix flakes enabled:\n\n$ nix run \\\n --option extra-substituters 'https:\/\/nixpkgs-update.cachix.org\/' \\\n --option extra-trusted-public-keys 'nixpkgs-update.cachix.org-1:6y6Z2JdoL3APdu6\/+Iy8eZX2ajf09e4EE9SnxSML1W8=' \\\n github:ryantm\/nixpkgs-update -- --help\n\nInstall into your Nix profile:\n\n$ nix-env \\\n --option extra-substituters 'https:\/\/nixpkgs-update.cachix.org\/' \\\n --option extra-trusted-public-keys 'nixpkgs-update.cachix.org-1:6y6Z2JdoL3APdu6\/+Iy8eZX2ajf09e4EE9SnxSML1W8=' \\\n -if https:\/\/github.com\/ryantm\/nixpkgs-update\/archive\/main.tar.gz\n\nDeclaratively with niv:\n\n$ niv add ryantm\/nixpkgs-update\n\nNixOS config with Niv:\n\nlet\n sources = import .\/nix\/sources.nix;\n nixpkgs-update = import sources.nixpkgs-update {};\nin\n environment.systemPackages = [ nixpkgs-update ];\n\nhome-manager config with Niv:\n\nlet\n sources = import .\/nix\/sources.nix;\n nixpkgs-update = import sources.nixpkgs-update {};\nin\n home.packages = [ nixpkgs-update ];\n" } +,{ "url": "interactive-updates\/", "title": "Interactive updates", "text": "Interactive updatesnixpkgs-update supports interactive, single package updates via the update subcommand.\n\nUpdate tutorial\n\n1. Setup hub and give it your GitHub credentials. Alternatively, if you prefer not to install and configure hub, you\n can manually create a GitHub token with repo and gist scopes. Provide it to nixpkgs-update by exporting it as the\n GITHUB_TOKEN environment variable (nixpkgs-update reads credentials from the files hub uses but no longer uses hub\n itself).\n2. Go to your local checkout of nixpkgs, and make sure the working directory is clean. Be on a branch you are okay\n committing to.\n3. Ensure that there is an Git origin called upstream which points to nixpkgs:\n git remote add upstream \"https:\/\/github.com\/NixOS\/nixpkgs.git\"\n4. Run it like: nixpkgs-update update \"postman 7.20.0 7.21.2\" which mean update the package \"postman\" from\n version 7.20.0 to version 7.21.2.\n5. It will run the updater, and, if the update builds, it will commit the update and output a message you could use for\n a pull request.\n\nFlags\n\n--cve\n\nadds CVE vulnerability reporting to the PR message. On first invocation with this option, a CVE database is built.\nSubsequent invocations will be much faster.\n\n--nixpkgs-review\n\nruns nixpkgs-review, which tries to build all the packages that depend on the one being updated and adds a report.\n" } +,{ "url": "batch-updates\/", "title": "Batch updates", "text": "Batch updatesnixpkgs-update supports batch updates via the update-list subcommand.\n\nUpdate-List tutorial\n\n1. Setup hub and give it your GitHub credentials, so it saves an oauth token. This allows nixpkgs-update to query the\n GitHub API. Alternatively, if you prefer not to install and configure hub, you can manually create a GitHub token\n with repo and gist scopes. Provide it to nixpkgs-update by exporting it as the GITHUB_TOKEN environment variable\n (nixpkgs-update reads credentials from the files hub uses but no longer uses hub itself).\n\n2. Clone this repository and build nixpkgs-update:\n \n git clone https:\/\/github.com\/ryantm\/nixpkgs-update && cd nixpkgs-update\n nix-build\n\n3. To test your config, try to update a single package, like this:\n \n .\/result\/bin\/nixpkgs-update update \"pkg oldVer newVer update-page\"`\n \n # Example:\n .\/result\/bin\/nixpkgs-update update \"tflint 0.15.0 0.15.1 repology.org\"`\n\n replacing tflint with the attribute name of the package you actually want to update, and the old version and new\n version accordingly.\n \n If this works, you are now setup to hack on nixpkgs-update! If you run it with --pr, it will actually send a pull\n request, which looks like this: https:\/\/github.com\/NixOS\/nixpkgs\/pull\/82465\n\n4. If you'd like to send a batch of updates, get a list of outdated packages and place them in a packages-to-update.txt\n file:\n\n.\/result\/bin\/nixpkgs-update fetch-repology > packages-to-update.txt\n\nThere also exist alternative sources of updates, these include:\n\n - PyPI, the Python Package Index: nixpkgs-update-pypi-releases\n - GitHub releases: nixpkgs-update-github-releases\n\n5. Run the tool in batch mode with update-list:\n\n.\/result\/bin\/nixpkgs-update update-list\n" } +,{ "url": "r-ryantm\/", "title": "r-ryantm", "text": "r-ryantm@r-ryantm, is a bot account that updates Nixpkgs by making PRs that bump a package to the latest version. It\nruns on community-configured infrastructure.\n" } +,{ "url": "details\/", "title": "Details", "text": "DetailsSome of these features only apply to the update-list sub-command or to features only available to the @r-ryantm\nbot.\n\nChecks\n\nA number of checks are performed to help nixpkgs maintainers gauge the likelihood that an update was successful. All the\nbinaries are run with various flags to see if they have a zero exit code and output the new version number. The outpath\ndirectory tree is searched for files containing the new version number. A directory tree and disk usage listing is\nprovided.\n\nSecurity report\n\nInformation from the National Vulnerability Database maintained by NIST is compared against the current and updated\npackage version. The nixpkgs package name is matched with the Common Platform Enumeration vendor, product, edition,\nsoftware edition, and target software fields to find candidate Common Vulnerabilities and Exposures (CVEs). The CVEs are\nfiltered by the matching the current and updated versions with the CVE version ranges.\n\nThe general philosophy of the CVE search is to avoid false negatives, which means we expect to generate many false\npositives. The false positives can be carefully removed by manually created rules implemented in the filter function in\nthe NVDRules module.\n\nIf there are no CVE matches, the report is not shown. The report has three parts: CVEs resolved by this update, CVEs\nintroduced by this update, and CVEs present in both version.\n\nIf you would like to report a problem with the security report, please use the nixpkgs-update GitHub issues.\n\nThe initial development of the security report was made possible by a partnership with Serokell and the NLNet Foundation\nthrough their Next Generation Internet Zero Discovery initiative (NGI0 Discovery). NGI0 Discovery is made possible with\nfinancial support from the European Commission.\n\nRebuild report\n\nThe PRs made by nixpkgs-update say what packages need to be rebuilt if the pull request is merged. This uses the same\nmechanism OfBorg uses to put rebuild labels on PRs. Not limited by labels, it can report the exact number of rebuilds\nand list some of the attrpaths that would need to be rebuilt.\n\nPRs against staging\n\nIf a PR merge would cause more than 500 packages to be rebuilt, the PR is made against staging.\n\nLogs\n\nLogs from r-ryantm's runs are available online. There are a lot of packages nixpkgs-update currently has no hope of\nupdating. Please dredge the logs to find out why your pet package is not receiving updates.\n\nCachix\n\nBy uploading the build outputs to Cachix, nixpkgs-update allows you to test a package with one command.\n" } +,{ "url": "contributing\/", "title": "Contributing", "text": "ContributingIncremental development:\n\nnix-shell --run \"cabal v2-repl\"\n\nRun the tests:\n\nnix-shell --run \"cabal v2-test\"\n\nRun a type checker in the background for quicker type checking feedback:\n\nnix-shell --run \"ghcid\"\n\nRun a type checker for the app code:\n\nnix-shell --run 'ghcid -c \"cabal v2-repl exe:nixpkgs-update\"'\n\nRun a type checker for the test code:\n\nnix-shell --run 'ghcid -c \"cabal v2-repl tests\"'\n\nUpdating the Cabal file when adding new dependencies or options:\n\nnix run nixpkgs#haskellPackages.hpack\n\nSource files are formatted with Ormolu.\n\nThere is also a Cachix cache available for the dependencies of this program.\n" } +,{ "url": "donate\/", "title": "Donate", "text": "Donate@r-ryantm, the bot that updates Nixpkgs, is currently running on a Hetzner bare-metal server that costs me €60 per\nmonth. Your support in paying for infrastructure would be a great help:\n\n - GitHub Sponsors\n - Patreon\n" } +,{ "url": "nixpkgs-maintainer-faq\/", "title": "Nixpkgs Maintainer FAQ", "text": "Nixpkgs Maintainer FAQ@r-ryantm opened a PR for my package, what do I do?\n\nThanks for being a maintainer. Hopefully, @r-ryantm will be able to save you some time!\n\n1. Review the PR diff, making sure this update makes sense\n - sometimes updates go backward or accidentally use a dev version\n2. Review upstream changelogs and commits\n3. Follow the \"Instructions to test this update\" section of the PR to get the built program on your computer quickly\n4. Make a GitHub Review approving or requesting changes. Include screenshots or other notes as appropriate.\n\nWhy is @r-ryantm not updating my package?There are lots of reasons a package might not be updated. You can usually\nfigure out which one is the issue by looking at the logs or by asking @ryantm on Matrix or GitHub.\n\nNo new version information\n\nr-ryantm gets its new version information from three sources:\n\n - Repology - information from Repology is delayed because it only updates when there is an unstable channel release\n - GitHub releases\n - PyPi releases\n\nIf none of these sources says the package is out of date, it will not attempt to update it.\n\nSkiplist\n\nWe maintain a Skiplist of different things not to update. It is possible your package is triggering one of the skip\ncriteria.\n\nPython updates are skipped if they cause more than 25 rebuilds.\n\nExisting Open or Draft PR\n\nIf there is an existing PR with the exact title of $attrPath: $oldVersion -> $newVersion, it will not update the\npackage.\n\nVersion not newer\n\nIf Nix's builtins.compareVersions does not think the \"new\" version is newer, it will not update.\n\nIncompatibile with \"Path Pin\"\n\nSome attrpaths have versions appended to the end of them, like ruby_3_0, the new version has to be compatible with this\n\"Path pin\". Here are some examples:\n\n-- >>> versionCompatibleWithPathPin \"libgit2_0_25\" \"0.25.3\"\n-- True\n--\n-- >>> versionCompatibleWithPathPin \"owncloud90\" \"9.0.3\"\n-- True\n--\n-- >>> versionCompatibleWithPathPin \"owncloud-client\" \"2.4.1\"\n-- True\n--\n-- >>> versionCompatibleWithPathPin \"owncloud90\" \"9.1.3\"\n-- False\n--\n-- >>> versionCompatibleWithPathPin \"nodejs-slim-10_x\" \"11.2.0\"\n-- False\n--\n-- >>> versionCompatibleWithPathPin \"nodejs-slim-10_x\" \"10.12.0\"\n-- True\n\nCan't find derivation file\n\nIf nix edit $attrpath does not open the correct file that contains the version string and fetcher hash, the update will\nfail.\n\nThis might not work, for example, if a package doesn't have a meta attr (at all, or if the package uses a builder\nfunction that is discarding the meta attr).\n\nUpdate already merged\n\nIf the update is already on master, staging, or staging-next, the update will fail.\n\nCan't find hash or source url\n\nIf the derivation file has no hash or source URL, it will fail.\n\nSince nixpkgs-update is trying to read these from .src, this can also happen if the package's source is something\nunexpected such as another package. You can set the fallback originalSrc attr so that nixpkgs-update can find the\ncorrect source in cases like this.\n\nNo updateScript and no version\n\nIf the derivation file has no version and no updateScript, it will fail.\n\nNo changes\n\nIf the derivation \"Rewriters\" fail to change the derivation, it will fail.\n\nIf there is no updateScript, and the source url or the hash did not change, it will fail.\n\nNo rebuilds\n\nIf the rewrites didn't cause any derivations to change, it will fail.\n\nDidn't build\n\nIf after the rewrites, it doesn't build, it will fail.\n" } +] \ No newline at end of file