| # frozen_string_literal: true | |
| # This file is loaded twice — once as `node:`, once aliased as `javascript:` — | |
| # so these are methods rather than constants to avoid redefinition warnings. | |
| def webdriver_package_json | |
| 'javascript/selenium-webdriver/package.json' | |
| end | |
| def atoms_package_json | |
| 'javascript/atoms/package.json' | |
| end | |
| def webdriver_publish_target | |
| '//javascript/selenium-webdriver:selenium-webdriver.publish' | |
| end | |
| def atoms_publish_target | |
| '//javascript/atoms:selenium-atoms-package.publish' | |
| end | |
| def node_version | |
| SeleniumRake.version('javascript') | |
| end | |
| def publish_npm_package(target, config, dry_run) | |
| bazel_args = ["--config=#{config}"] | |
| bazel_args += ['--', '--dry-run=true'] if dry_run | |
| Bazel.execute('run', bazel_args, target) | |
| rescue RuntimeError => e | |
| raise if dry_run | |
| raise unless e.message.match?(/cannot publish over the previously published/i) | |
| puts "#{target} version already published — skipping." | |
| end | |
| def setup_github_npm_auth | |
| token = ENV.fetch('GITHUB_TOKEN', nil) | |
| raise 'Missing GitHub token: set GITHUB_TOKEN for nightly npm publish' if token.nil? || token.empty? | |
| # Configure npm for GitHub Packages | |
| npmrc = File.join(Dir.home, '.npmrc') | |
| npmrc_content = [ | |
| "//npm.pkg.github.com/:_authToken=#{token}", | |
| '@seleniumhq:registry=https://npm.pkg.github.com', | |
| 'always-auth=true' | |
| ].join("\n") | |
| if File.exist?(npmrc) | |
| File.open(npmrc, 'a') { |f| f.puts("\n#{npmrc_content}") } | |
| else | |
| File.write(npmrc, "#{npmrc_content}\n") | |
| end | |
| File.chmod(0o600, npmrc) | |
| # Update package.json for GitHub Packages | |
| content = File.read(webdriver_package_json) | |
| content = content.gsub('https://registry.npmjs.org/', 'https://npm.pkg.github.com') | |
| content = content.gsub('"name": "selenium-webdriver"', '"name": "@seleniumhq/selenium-webdriver"') | |
| File.write(webdriver_package_json, content) | |
| # GitHub Packages only accepts the repository owner's scope, so @selenium | |
| # becomes @seleniumhq. It also derives visibility from the repository, so | |
| # drop the npmjs access flag rather than send one it does not honour. | |
| content = File.read(atoms_package_json) | |
| content = content.gsub('https://registry.npmjs.org/', 'https://npm.pkg.github.com') | |
| content = content.gsub('"name": "@selenium/atoms"', '"name": "@seleniumhq/atoms"') | |
| content = content.gsub(/^\s*"access": "public",\n/, '') | |
| File.write(atoms_package_json, content) | |
| end | |
| desc 'Build Node npm packages' | |
| task :build do |_task, arguments| | |
| args = arguments.to_a | |
| Bazel.execute('build', args, '//javascript/atoms:selenium-atoms-package') | |
| Bazel.execute('build', args, '//javascript/selenium-webdriver') | |
| end | |
| desc 'Pin JavaScript dependencies via pnpm lockfile' | |
| task :pin do | |
| Bazel.execute('run', ['--', 'install', '--dir', Dir.pwd, '--lockfile-only'], '@pnpm//:pnpm') | |
| end | |
| desc 'Update JavaScript dependencies to latest versions within specified range' | |
| task :update do |_task, arguments| | |
| # update versions beyond the specified range | |
| upgrade = arguments.to_a.include?('latest') | |
| args = ['--', 'update', '-r', '--dir', Dir.pwd] | |
| args << '--latest' if upgrade | |
| Bazel.execute('run', args, '@pnpm//:pnpm') | |
| Rake::Task['node:pin'].invoke | |
| end | |
| desc 'Validate Node release credentials' | |
| task :check_credentials do |_task, arguments| | |
| nightly = arguments.to_a.include?('nightly') | |
| next if nightly | |
| npmrc = File.join(Dir.home, '.npmrc') | |
| has_file = File.exist?(npmrc) && File.read(npmrc).include?('//registry.npmjs.org/:_authToken=') | |
| has_oidc = ENV.fetch('ACTIONS_ID_TOKEN_REQUEST_URL', nil) && !ENV['ACTIONS_ID_TOKEN_REQUEST_URL'].empty? | |
| unless has_file || has_oidc | |
| raise 'Missing npm credentials: configure ~/.npmrc via `npm login` or run via npm trusted publishing' | |
| end | |
| end | |
| desc 'Release Node npm package (use dry-run to test without publishing)' | |
| task :release do |_task, arguments| | |
| args = arguments.to_a | |
| nightly = args.delete('nightly') | |
| dry_run = args.delete('dry-run') | |
| config = args.delete('rbe') ? 'rbe_release' : 'release' | |
| Rake::Task['node:check_credentials'].invoke(*(nightly ? ['nightly'] : [])) unless dry_run | |
| if nightly | |
| Rake::Task['node:version'].invoke('nightly') | |
| # Each nightly publish needs its own version; the committed one has no timestamp | |
| SeleniumRake.write_version('javascript', "#{node_version}#{Time.now.strftime('%Y%m%d%H%M')}") | |
| setup_github_npm_auth unless dry_run | |
| end | |
| puts dry_run ? 'Running Node package dry-run...' : 'Running Node package release...' | |
| # @selenium/atoms publishes first so the lower-level package is on the | |
| # registry before anything that may start depending on it. | |
| publish_npm_package(atoms_publish_target, config, dry_run) | |
| publish_npm_package(webdriver_publish_target, config, dry_run) | |
| end | |
| desc 'Release @selenium/manager standalone packages to npm (use dry-run to test without publishing)' | |
| task :release_manager do |_task, arguments| | |
| args = arguments.to_a | |
| nightly = args.delete('nightly') | |
| dry_run = args.delete('dry-run') | |
| config = args.delete('rbe') ? 'rbe_release' : 'release' | |
| # Nightlies go to GitHub Packages, which only accepts the @seleniumhq scope; | |
| # the manager is only ever published as @selenium/manager, so it skips them. | |
| if nightly | |
| puts '@selenium/manager is published only in releases — skipping nightly.' | |
| next | |
| end | |
| Rake::Task['node:check_credentials'].invoke unless dry_run | |
| targets = [ | |
| '//javascript/selenium-manager-linux-x64:selenium-manager-linux-x64.publish', | |
| '//javascript/selenium-manager-linux-arm64:selenium-manager-linux-arm64.publish', | |
| '//javascript/selenium-manager-darwin:selenium-manager-darwin.publish', | |
| '//javascript/selenium-manager-win32-ia32:selenium-manager-win32-ia32.publish', | |
| '//javascript/selenium-manager:selenium-manager.publish' | |
| ] | |
| targets.each do |target| | |
| puts dry_run ? "Dry-run: #{target}" : "Publishing: #{target}" | |
| publish_npm_package(target, config, dry_run) | |
| end | |
| end | |
| desc 'Verify Node packages are published on npm' | |
| task :verify do | |
| SeleniumRake.verify_package_published("https://registry.npmjs.org/selenium-webdriver/#{node_version}") | |
| SeleniumRake.verify_package_published("https://registry.npmjs.org/@selenium%2Fatoms/#{node_version}") | |
| end | |
| desc 'Alias for node:release' | |
| task deploy: :release | |
| desc 'Generate and stage Node documentation' | |
| task :docs do |_task, arguments| | |
| if node_version.include?('nightly') && !arguments.to_a.include?('force') | |
| abort('Aborting documentation update: nightly versions should not update docs.') | |
| end | |
| Rake::Task['node:docs_generate'].invoke | |
| end | |
| desc 'Generate Node documentation without staging' | |
| task :docs_generate do | |
| puts 'Generating Node documentation' | |
| FileUtils.rm_rf('build/docs/api/javascript/') | |
| Bazel.execute('run', [], '//javascript/selenium-webdriver:docs') | |
| end | |
| desc 'Install Node package locally via pnpm link' | |
| task :install do | |
| Bazel.execute('build', ['--stamp'], '//javascript/selenium-webdriver') | |
| pkg_dir = File.expand_path('bazel-bin/javascript/selenium-webdriver/selenium-webdriver') | |
| Bazel.execute('run', ['--', '--dir', pkg_dir, 'link', '--global'], '@pnpm//:pnpm') | |
| end | |
| desc 'Update JavaScript changelog' | |
| task :changelogs do | |
| header = "## #{node_version}\n" | |
| SeleniumRake.update_changelog(node_version, 'javascript', 'javascript/selenium-webdriver/', | |
| 'javascript/selenium-webdriver/CHANGES.md', header) | |
| end | |
| desc 'Update Node version' | |
| task :version, [:version] do |_task, arguments| | |
| old_version = node_version | |
| new_version = SeleniumRake.updated_version(old_version, arguments[:version], '-nightly') | |
| puts "Updating Node from #{old_version} to #{new_version}" | |
| SeleniumRake.write_version('javascript', new_version) | |
| end | |
| desc 'Format JavaScript code with prettier' | |
| task :format do | |
| node_dir = File.expand_path('javascript/selenium-webdriver') | |
| prettier_config = File.join(node_dir, '.prettierrc') | |
| puts ' Running prettier...' | |
| Bazel.execute('run', ['--', node_dir, '--write', "--config=#{prettier_config}", '--log-level=warn'], | |
| '//javascript:prettier') | |
| end | |
| desc 'Run JavaScript linter (docs only for now, eslint needs bazel integration work)' | |
| task :lint do | |
| # TODO: Add eslint once bazel target properly resolves workspace modules | |
| Rake::Task['node:docs_generate'].invoke | |
| end |