Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: deprecate old versions #3666

Merged
merged 8 commits into from
Feb 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions .github/workflows/release-deprecate.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: "Deprecate Old Versions"

on:
workflow_dispatch:
inputs:
deprecate_versions:
type: boolean
description: Deprecate versions? Otherwise dry-run mode will be used.
default: false
filter_by_package_name:
type: string
description: Filter by package name
default: ""
filter_by_package_version:
type: string
description: Filter by package version
default: ""
chunk_size:
type: number
description: Chunk size
default: 1000

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
deprecate-npm-versions:
name: Deprecate versions next, pr and rc
runs-on: buildjet-4vcpu-ubuntu-2204
environment: npm-deploy
steps:
- name: Checkout
uses: actions/checkout@v4

- name: CI Setup
uses: ./.github/actions/ci-setup

- name: Setup NPM registry
uses: FuelLabs/github-actions/setups/npm@master
with:
npm-token: ${{ secrets.NPM_DEPLOY_TOKEN }}

- name: Deprecate
run: pnpm release:deprecate
env:
DEPRECATE_VERSIONS: ${{ github.event.inputs.deprecate_versions }}
FILTER_BY_PACKAGE_NAME: ${{ github.event.inputs.filter_by_package_name }}
FILTER_BY_VERSION: ${{ github.event.inputs.filter_by_package_version }}
CHUNK_SIZE: ${{ github.event.inputs.chunk_size }}
28 changes: 22 additions & 6 deletions scripts/release-deprecate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,12 @@ const deprecateTags = /next|pr|rc/;
const { version: currentVersion } = JSON.parse(
readFileSync(join(process.cwd(), '/packages/fuels/package.json')).toString()
);
const deprecateVersions = process.env.DEPRECATE_VERSIONS === 'true';
const SHOULD_DEPRECATE_VERSIONS: boolean = process.env.DEPRECATE_VERSIONS === 'true';
const CHUNK_SIZE: number = process.env.CHUNK_SIZE ? parseInt(process.env.CHUNK_SIZE, 10) : 1000;
petertonysmith94 marked this conversation as resolved.
Show resolved Hide resolved
const FILTER_BY_PACKAGE_NAME: string = process.env.FILTER_BY_PACKAGE_NAME ?? '';
const FILTER_BY_VERSION: string = process.env.FILTER_BY_VERSION ?? '';

const getPublicPackages = () => {
const getPublicPackages = (): string[] => {
const packagesDir = join(__dirname, '../packages');
const packages = readdirSync(packagesDir, { withFileTypes: true });
const packagesNames = packages.map((p) => {
Expand All @@ -26,7 +29,7 @@ const getPublicPackages = () => {
return packagesNames.filter((p) => !!p);
};

const getVersionsToDeprecate = async (packageName: string) => {
const getVersionsToDeprecate = async (packageName: string): Promise<string[]> => {
const { versions } = await fetch(`https://registry.npmjs.org/${packageName}`).then((resp) =>
resp.json()
);
Expand All @@ -42,15 +45,26 @@ const getVersionsToDeprecate = async (packageName: string) => {
};

const main = async () => {
const packages = getPublicPackages();
let packages = getPublicPackages();
if (FILTER_BY_PACKAGE_NAME !== '') {
packages = packages.filter((packageName) => packageName === FILTER_BY_PACKAGE_NAME);
}

await Promise.allSettled(
packages.map(async (packageName) => {
const versionsToDeprecate = await getVersionsToDeprecate(packageName);
const allVersions = await getVersionsToDeprecate(packageName);

let versionsToDeprecate = allVersions.splice(0, CHUNK_SIZE);
if (FILTER_BY_VERSION !== '') {
versionsToDeprecate = versionsToDeprecate.filter(
(version) => version === FILTER_BY_VERSION
);
}

log('The following versions will be deprecated:');
log(versionsToDeprecate.map((v) => ` - ${v}`).join('\n'));

if (deprecateVersions) {
if (SHOULD_DEPRECATE_VERSIONS) {
await Promise.allSettled(
versionsToDeprecate.map(
async (versionToDelete) =>
Expand All @@ -60,11 +74,13 @@ const main = async () => {
(err, _stdout, stderr) => {
if (err) {
log(`❌ Error ${packageName}@${versionToDelete} not deprecated!\n`);
error(err);
reject(err);
return;
}
if (stderr) {
log(`❌ Error ${packageName}@${versionToDelete} not deprecated!\n`);
error(stderr);
reject(new Error(stderr));
return;
}
Expand Down