From e73a0e6cc66665d83242e263bc8718c42ffd7c7e Mon Sep 17 00:00:00 2001 From: Samuel Attard Date: Tue, 21 May 2019 00:17:08 -0700 Subject: [PATCH] docs: replace the atom.io headers URL with electronjs.org (#18328) --- docs/api/breaking-changes.md | 10 ++++++++++ docs/tutorial/using-native-node-modules.md | 4 ++-- native_mate/README.md | 2 +- script/upload-node-checksums.py | 2 +- tools/dump-version-info.js | 2 +- 5 files changed, 15 insertions(+), 5 deletions(-) diff --git a/docs/api/breaking-changes.md b/docs/api/breaking-changes.md index 3e02a57aba21..7875a1fecfa5 100644 --- a/docs/api/breaking-changes.md +++ b/docs/api/breaking-changes.md @@ -8,6 +8,16 @@ The `FIXME` string is used in code comments to denote things that should be fixe ## Planned Breaking API Changes (7.0) +### Node Headers URL + +This is the URL specified as `disturl` in a `.npmrc` file or as the `--dist-url` +command line flag when building native Node modules. Both will be supported for +the forseeable future but it is reccomened that you switch. + +Deprecated: https://atom.io/download/electron + +Replace with: https://electronjs.org/headers + ### `session.clearAuthCache(options)` The `session.clearAuthCache` API no longer accepts options for what to clear, and instead unconditionally clears the whole cache. diff --git a/docs/tutorial/using-native-node-modules.md b/docs/tutorial/using-native-node-modules.md index 9bb57be44ea5..58e855ffe62e 100644 --- a/docs/tutorial/using-native-node-modules.md +++ b/docs/tutorial/using-native-node-modules.md @@ -55,7 +55,7 @@ export npm_config_target=1.2.3 export npm_config_arch=x64 export npm_config_target_arch=x64 # Download headers for Electron. -export npm_config_disturl=https://atom.io/download/electron +export npm_config_disturl=https://electronjs.org/headers # Tell node-pre-gyp that we are building for Electron. export npm_config_runtime=electron # Tell node-pre-gyp to build module from source code. @@ -72,7 +72,7 @@ use `node-gyp` directly to build for Electron: ```sh cd /path-to-module/ -HOME=~/.electron-gyp node-gyp rebuild --target=1.2.3 --arch=x64 --dist-url=https://atom.io/download/electron +HOME=~/.electron-gyp node-gyp rebuild --target=1.2.3 --arch=x64 --dist-url=https://electronjs.org/headers ``` * `HOME=~/.electron-gyp` changes where to find development headers. diff --git a/native_mate/README.md b/native_mate/README.md index e5d056bfed9f..655e8f7f1231 100644 --- a/native_mate/README.md +++ b/native_mate/README.md @@ -53,4 +53,4 @@ void Initialize(v8::Handle exports) { [chromium-gin-lib]: https://code.google.com/p/chromium/codesearch#chromium/src/gin/README.md&sq=package:chromium -[electron]: http://electron.atom.io/ +[electron]: https://electronjs.org/ diff --git a/script/upload-node-checksums.py b/script/upload-node-checksums.py index 4d301ce2b937..bc701a3c7b43 100755 --- a/script/upload-node-checksums.py +++ b/script/upload-node-checksums.py @@ -10,7 +10,7 @@ import tempfile from lib.config import s3_config from lib.util import download, rm_rf, s3put, safe_mkdir -DIST_URL = 'https://atom.io/download/electron/' +DIST_URL = 'https://electronjs.org/headers/' def main(): diff --git a/tools/dump-version-info.js b/tools/dump-version-info.js index 67bc2f99e729..73f0532bd1f3 100644 --- a/tools/dump-version-info.js +++ b/tools/dump-version-info.js @@ -2,7 +2,7 @@ var app = require('electron').app var fs = require('fs') var request = require('request') -var TARGET_URL = 'https://atom.io/download/electron/index.json' +var TARGET_URL = 'https://electronjs.org/headers/index.json' function getDate () { var today = new Date()