Update prune-prereleases.js pruning rules

[hellwolf]

Pruning rules:

1. only keep the earliest release of the month
2. to keep the newest 3 nightlies

Fixes #6732

Here is my local testing:

import { Octokit, App } from "octokit";

// Create a personal access token at https://github.com/settings/tokens/new?scopes=repo
const octokit = new Octokit({ });

// In case node 21 is not used.
function groupBy(array, keyOrIterator) {
    var iterator;

    // use the function passed in, or create one
    if(typeof keyOrIterator !== 'function') {
        const key = String(keyOrIterator);
        iterator = function (item) { return item[key]; };
    } else {
        iterator = keyOrIterator;
    }

    return array.reduce(function (memo, item) {
        const key = iterator(item);
        memo[key] = memo[key] || [];
        memo[key].push(item);
        return memo;
    }, {});
}

async function separateReleases({ github, context }) {
    console.log("Pruning old prereleases");

    // doc: https://docs.github.com/en/rest/releases/releases
    const { data: releases } = await github.rest.repos.listReleases({
        owner: context.repo.owner,
        repo: context.repo.repo,
    });

    let nightlies = releases.filter(
        release =>
        // Only consider releases tagged `nightly-${SHA}` for deletion
        release.tag_name.includes("nightly") &&
        release.tag_name !== "nightly"
    );

    // group releases by months
    const groups = groupBy(nightlies, i => i.created_at.slice(0, 7));

    // Pruning rules:
    //   1. only keep the earliest release of the month
    //   2. to keep the newest 3 nightlies
    const toPrune = Object.values(groups)
        .reduce((acc, cur) => acc.concat(cur.slice(0, -1)), [])
        .slice(3);

    const toKeep = Object.values(groups).reduce((acc, cur) => acc.concat(cur.slice(-1)), []);

    return {
        toPrune,
        toKeep,
    };
};

(async() => {
    const releases = await separateReleases({
        github : octokit,
        context : {
            repo : { owner: "foundry-rs", repo: "foundry" }
        },
    });
    console.log("To prune:", releases.toPrune.map(i => i.name));
    console.log("To keep:", releases.toKeep.map(i => i.name));
})();

$ node index.mjs 
Pruning old prereleases
To prune: [ 'Nightly (2023-11-01)' ]
To keep: [
  'Nightly (2024-01-12)',
  'Nightly (2023-12-02)',
  'Nightly (2023-11-02)',
  'Nightly (2023-10-02)',
  'Nightly (2023-08-02)',
  'Nightly (2023-07-02)',
  'Nightly (2023-06-02)',
  'Nightly (2023-05-02)',
  'Nightly (2023-04-02)',
  'Nightly (2023-03-02)',
  'Nightly (2023-01-03)'
]

Motivation

Solution

[onbjerg]

Is the test result not incorrect? If it is supposed to keep the first release of the month it should be pruning 2023-11-02, not 2023-11-01

[hellwolf]

Is the test result not incorrect? If it is supposed to keep the first release of the month it should be pruning 2023-11-02, not 2023-11-01

I think there could be some mismatch between the "name" and created_time or published_time field, perhaps due to timezones.

By default the github releases seem to be sorted by created_time. That should make it consistent. To be precise, the comment could be improved to clarify this.

[onbjerg]

Let's include the clarification and this overall LGTM

[hellwolf]

Let's include the clarification and this overall LGTM

Yep. I find a quote from the doc:

| The latest release is the most recent non-prerelease, non-draft release, sorted by the created_at attribute.

Made a commit to the patch.

[shazow]

@hellwolf Thanks for doing this!

[mattsse]

sgtm!
pending @onbjerg