chore(CI): add nightly publish workflow (#2890)

## Description

Original PR: #2887
See it for description.

## Changes

WIP

## Test code and steps to reproduce

WIP

## Checklist

- [ ] Ensured that CI passes

---------

Co-authored-by: Artur Bilski <[email protected]>

Author: kkafar

.github/workflows/helper/clear-annotations.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+# Eliminate those annoying annotations from GitHub Actions
+echo "::remove-matcher owner=eslint-compact::"
+echo "::remove-matcher owner=eslint-stylish::"
+echo "::remove-matcher owner=tsc::"

.github/workflows/npm-screens-publish-nightly.yml

@@ -0,0 +1,66 @@
+name: Build nightly and publish on npm
+env:
+  YARN_ENABLE_HARDENED_MODE: 0
+on:
+  schedule:
+    - cron: '27 23 * * *' # at 23:27 every day
+  workflow_dispatch:
+jobs:
+  npm-build:
+    if: github.repository == 'software-mansion/react-native-screens'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    env:
+      PACKAGE_NAME: PLACEHOLDER # Will be reassigned later on.
+    steps:
+      - name: Check out
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: 'yarn'
+          registry-url: https://registry.npmjs.org/
+
+      - name: Clear annotations
+        run: .github/workflows/helper/clear-annotations.sh
+
+      - name: Install node dependencies
+        run: yarn install --immutable
+
+      - name: Build package
+        id: build
+        run: ./scripts/create-npm-package.sh
+
+      - name: Check if any node_modules were packed
+        id: node_modules
+        run: ! grep --silent -E "node_modules/.+" build.log
+
+      - name: Show build log
+        if: failure() && steps.build.outcome == 'failure'
+        run: cat build.log
+
+      - name: Show packed node_modules
+        if: failure() && steps.node_modules.outcome == 'failure'
+        run: ! grep -E "node_modules/.+" build.log
+
+      - name: Add package name to env
+        run: echo "PACKAGE_NAME=$(ls -l | egrep -o "react-native-screens-(.*)(=?\.tgz)")" >> $GITHUB_ENV
+
+      - name: Assert PACKAGE_NAME
+        if: ${{ env.PACKAGE_NAME == 'PLACEHOLDER' }}
+        run: exit 1 # This should never happen.
+
+      - name: Upload npm package to GitHub
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ env.PACKAGE_NAME }}
+          path: './${{ env.PACKAGE_NAME }}'
+
+      - name: Publish npm package
+        run: npm publish $PACKAGE_NAME --tag nightly --provenance
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_ACCESS_TOKEN }}

package.json

@@ -91,6 +91,7 @@
     "@types/jest": "^29.5.13",
     "@types/react": "^19.0.0",
     "@types/react-test-renderer": "^19.0.0",
+    "@types/shelljs": "^0",
     "@typescript-eslint/eslint-plugin": "^6.5.0",
     "@typescript-eslint/parser": "^6.5.0",
     "clang-format": "^1.8.0",
@@ -116,6 +117,7 @@
     "react-native-windows": "^0.64.8",
     "react-test-renderer": "^19.0.0",
     "release-it": "^15.6.0",
+    "shelljs": "^0.9.2",
     "typescript": "5.4.3"
   },
   "resolutions": {

scripts/create-npm-package.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+yarn install --immutable
+
+if ! CURRENT_VERSION=$(node ./set-version.js --nightly); then
+  exit 1
+fi
+
+yarn prepare
+
+npm pack
+
+node ./set-version.js "$CURRENT_VERSION" >/dev/null
+
+echo "Done!"

scripts/releasing.js

@@ -0,0 +1,66 @@
+const { cat, exec } = require('shelljs');
+
+/**
+ * @param {string[]} args
+ * @param {string} packageJsonPath
+ * @returns {{ currentVersion: string; newVersion: string }}
+ */
+function getVersion(args, packageJsonPath) {
+  let IS_NIGHTLY = false;
+  let IS_SET_CUSTOM = false;
+
+  let customVersion = '';
+
+  args.slice(2).forEach(arg => {
+    if (arg === '--nightly' || arg === '-n') {
+      IS_NIGHTLY = true;
+    } else {
+      customVersion = arg;
+      IS_SET_CUSTOM = true;
+    }
+  });
+
+  if (IS_NIGHTLY && IS_SET_CUSTOM) {
+    throw new Error('Cannot set nightly or fresh version with custom version.');
+  }
+
+  if (!IS_SET_CUSTOM && !IS_NIGHTLY) {
+    throw new Error('Version not set.');
+  }
+
+  const packageJson = JSON.parse(cat(packageJsonPath));
+  const currentVersion = packageJson.version;
+
+  let newVersion = currentVersion;
+  if (IS_SET_CUSTOM) {
+    newVersion = customVersion;
+  } else {
+    if (currentVersion.includes('nightly')) {
+      throw new Error('Cannot set nightly version on a nightly version');
+    }
+
+    const dateIdentifier = new Date()
+      .toISOString()
+      .slice(0, -5)
+      .replace(/[-:T]/g, '')
+      .slice(0, -6);
+
+    const currentCommit = exec('git rev-parse HEAD', {
+      silent: true,
+    }).stdout.trim();
+    const shortCommit = currentCommit.slice(0, 9);
+
+    newVersion = `${
+      currentVersion.split('-')[0]
+    }-nightly-${dateIdentifier}-${shortCommit}`;
+  }
+
+  return {
+    currentVersion,
+    newVersion,
+  };
+}
+
+module.exports = {
+  getVersion,
+};

scripts/set-version.js

@@ -0,0 +1,18 @@
+const fs = require('fs');
+const path = require('path');
+const { getVersion } = require('./releasing');
+
+const packageJsonPath = path.resolve(__dirname, '../package.json');
+
+const { currentVersion, newVersion } = getVersion(
+  process.argv,
+  packageJsonPath
+);
+
+const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));
+packageJson.version = newVersion;
+const newPackageJson = JSON.stringify(packageJson, null, 2) + '\n';
+fs.writeFileSync(packageJsonPath, newPackageJson, 'utf-8');
+
+// Log the current version so it can be restored if needed.
+console.log(currentVersion);

yarn.lock

@@ -3527,6 +3527,16 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@types/glob@npm:~7.2.0":
+  version: 7.2.0
+  resolution: "@types/glob@npm:7.2.0"
+  dependencies:
+    "@types/minimatch": "npm:*"
+    "@types/node": "npm:*"
+  checksum: 10c0/a8eb5d5cb5c48fc58c7ca3ff1e1ddf771ee07ca5043da6e4871e6757b4472e2e73b4cfef2644c38983174a4bc728c73f8da02845c28a1212f98cabd293ecae98
+  languageName: node
+  linkType: hard
+
 "@types/graceful-fs@npm:^4.1.2":
   version: 4.1.9
   resolution: "@types/graceful-fs@npm:4.1.9"
@@ -3608,6 +3618,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@types/minimatch@npm:*":
+  version: 5.1.2
+  resolution: "@types/minimatch@npm:5.1.2"
+  checksum: 10c0/83cf1c11748891b714e129de0585af4c55dd4c2cafb1f1d5233d79246e5e1e19d1b5ad9e8db449667b3ffa2b6c80125c429dbee1054e9efb45758dbc4e118562
+  languageName: node
+  linkType: hard
+
 "@types/node-forge@npm:^1.3.0":
   version: 1.3.11
   resolution: "@types/node-forge@npm:1.3.11"
@@ -3666,6 +3683,16 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@types/shelljs@npm:^0":
+  version: 0.8.15
+  resolution: "@types/shelljs@npm:0.8.15"
+  dependencies:
+    "@types/glob": "npm:~7.2.0"
+    "@types/node": "npm:*"
+  checksum: 10c0/8cee3c2cee993d4e4b534712dbf3b47000f22e14cbc4fff5c09fd774272e2bfb9b7dfc654d81349a11ade93a94f3a75771e403cd31509565102c33f518185da8
+  languageName: node
+  linkType: hard
+
 "@types/stack-utils@npm:^2.0.0":
   version: 2.0.3
   resolution: "@types/stack-utils@npm:2.0.3"
@@ -12888,6 +12915,7 @@ __metadata:
     "@types/jest": "npm:^29.5.13"
     "@types/react": "npm:^19.0.0"
     "@types/react-test-renderer": "npm:^19.0.0"
+    "@types/shelljs": "npm:^0"
     "@typescript-eslint/eslint-plugin": "npm:^6.5.0"
     "@typescript-eslint/parser": "npm:^6.5.0"
     clang-format: "npm:^1.8.0"
@@ -12915,6 +12943,7 @@ __metadata:
     react-native-windows: "npm:^0.64.8"
     react-test-renderer: "npm:^19.0.0"
     release-it: "npm:^15.6.0"
+    shelljs: "npm:^0.9.2"
     typescript: "npm:5.4.3"
     warn-once: "npm:^0.1.0"
   peerDependencies:
@@ -13962,6 +13991,20 @@ __metadata:
   languageName: node
   linkType: hard
 
+"shelljs@npm:^0.9.2":
+  version: 0.9.2
+  resolution: "shelljs@npm:0.9.2"
+  dependencies:
+    execa: "npm:^1.0.0"
+    fast-glob: "npm:^3.3.2"
+    interpret: "npm:^1.0.0"
+    rechoir: "npm:^0.6.2"
+  bin:
+    shjs: bin/shjs
+  checksum: 10c0/2aed1e2ff344b03a36aa018326ab768e4af88e22b0f3d89fbb2f15bca1a6cf6209c6d523658ebc7fc7986675ea75c7bdbce0501201b8883f1db21b22a50d5e6d
+  languageName: node
+  linkType: hard
+
 "shimmer@npm:^1.1.0, shimmer@npm:^1.2.0":
   version: 1.2.1
   resolution: "shimmer@npm:1.2.1"