Deploy 'latest' into the root of gh-pages

Author: dfreeman

lib/deploy/plugin.js

@@ -5,6 +5,7 @@ const path = require('path');
 const execa = require('execa');
 const quickTemp = require('quick-temp');
 const hostedGitInfo = require('hosted-git-info');
+const walkSync = require('walk-sync');
 
 const VERSION_PREFIX = 'v';
 
@@ -48,7 +49,7 @@ module.exports = class AddonDocsDeployPlugin {
 
     return this._copyExistingFiles(context, relativeBuildDestination)
       .then(() => this._copyBuildOutput(context, stagingDirectory, relativeBuildDestination))
-      .then(() => this._verifyRootFiles(stagingDirectory))
+      .then(() => this._verifyRedirectFile(stagingDirectory))
       .then(() => this._updateVersionsManifest(stagingDirectory))
       .then(() => this._maybeUpdateLatest(context, stagingDirectory, fullBuildDestination))
       .then(() => context.distDir = stagingDirectory);
@@ -58,18 +59,13 @@ module.exports = class AddonDocsDeployPlugin {
     quickTemp.remove(this, 'deployStagingDirectory');
   }
 
-  _getVersionPath(version = this.userConfig.getVersionPath()) {
-    return `${VERSION_PREFIX}/${version}`;
+  _getVersionPath() {
+    return `${VERSION_PREFIX}/${this.userConfig.getVersionPath()}`;
   }
 
-  _verifyRootFiles(stagingDirectory) {
+  _verifyRedirectFile(stagingDirectory) {
     let vendorDir = `${__dirname}/../../vendor/ember-cli-addon-docs`;
-
-    if (!fs.existsSync(`${stagingDirectory}/index.html`)) {
-      fs.copySync(`${vendorDir}/index.html`, `${stagingDirectory}/index.html`);
-    }
-
-    let segmentCount = this._getRootURL().split('/').length + 2;
+    let segmentCount = this._getRootURL().split('/').length;
     let redirectContents = fs.readFileSync(`${vendorDir}/404.html`, 'utf-8');
     redirectContents = redirectContents.replace(/\bADDON_DOCS_SEGMENT_COUNT\b/g, segmentCount);
     fs.writeFileSync(`${stagingDirectory}/404.html`, redirectContents);
@@ -117,12 +113,20 @@ module.exports = class AddonDocsDeployPlugin {
   _maybeUpdateLatest(context, stagingDirectory) {
     if (!this.userConfig.shouldUpdateLatest()) { return; }
 
-    let latestDir = this._getVersionPath('latest');
-    let fullPath = path.join(stagingDirectory, latestDir);
     let deployVersion = this._latestDeployVersion();
-    return fs.remove(fullPath)
-      .then(() => fs.copy(context.distDir, fullPath))
-      .then(() => this._updateIndexContents(context, stagingDirectory, latestDir, deployVersion));
+    let manifestPath = `${stagingDirectory}/root-deploy-files.json`;
+    let deletions = [];
+
+    if (fs.existsSync(manifestPath)) {
+      for (let file of fs.readJSONSync(manifestPath)) {
+        deletions.push(fs.remove(`${stagingDirectory}/${file}`));
+      }
+    }
+
+    return Promise.all(deletions)
+      .then(() => fs.writeJSON(manifestPath, walkSync(context.distDir, { directories: false })))
+      .then(() => fs.copy(context.distDir, stagingDirectory))
+      .then(() => this._updateIndexContents(context, stagingDirectory, '', deployVersion));
   }
 
   _updateIndexContents(context, stagingDirectory, appRoot, deployVersion) {
@@ -145,7 +149,7 @@ module.exports = class AddonDocsDeployPlugin {
   }
 
   _latestDeployVersion() {
-    let path = this._getVersionPath('latest');
+    let path = '';
     let name = 'latest';
     let sha = this.userConfig.repoInfo.sha;
     let tag = this.userConfig.repoInfo.tag;

tests/dummy/app/pods/docs/deploying/template.md

@@ -20,7 +20,6 @@ Now take a look at the `gh-pages` branch either locally or on GitHub. You should
 
 ```sh
 ├── 404.html
-├── index.html
 ├── v
 │   └── [current-branch]
 │       ├── assets
@@ -30,12 +29,11 @@ Now take a look at the `gh-pages` branch either locally or on GitHub. You should
 ```
 
 Let's break down what each of those items is doing.
- - `index.html` simply redirects from the root of your gh-pages site to `/v/latest` (more details on that [below](#tag-deploys))
  - `404.html` contains [some smart redirect logic](https://github.com/rafrex/spa-github-pages) to keep you from having to use `locationType: 'hash'` in your dummy app
  - `versions.json` contains a manifest of the available versions of your documentation
  - `v/[current-branch]` contains all the files from your built docs app
 
-If you were to make a change to your dummy app and run `ember deploy production` again right now, the entry for `[current-branch]` in `version.json` and the entire contents of the `v/[current-branch]` directory would be replaced with the updated version of your site. Next we'll talk about how to manage keeping published documentation around for multiple versions of your addon.
+If you were to make a change to your dummy app and run `ember deploy production` again right now, the entry for `[current-branch]` in `versions.json` and the entire contents of the `v/[current-branch]` directory would be replaced with the updated version of your site. Next we'll talk about how to manage keeping published documentation around for multiple versions of your addon.
 
 ## Versioning your content
 
@@ -45,15 +43,15 @@ Whenever you deploy your documentation site with Addon Docs, it places the compi
 
 When you run `ember deploy` at a commit that has a git tag associated with it, the app will wind up in a directory named after that tag. For example, if you've just published version 1.2.3 of your addon (creating tag `v1.2.3` in your git repository), your deployed site will be available at <u>https://**[user]**.github.io/**[repo]**/v/1.2.3</u>.
 
-By default, deploying from a tagged commit also places a copy of your app under a special directory called `/v/latest`. As mentioned above, the `index.html` that Addon Docs sets up at the root redirects to `/v/latest`, so <u>https://**[user]**.github.io/**[repo]**</u> will always bring developers to the documentation for the most recent stable release of your addon.
+By default, deploying from a tagged commit also places a copy of your app at the root of your `gh-pages` branch, so <u>https://**[user]**.github.io/**[repo]**</u> will always bring developers to the documentation for the most recent stable release of your addon.
 
-Note that this only applies to non-prerelease tags, so `v1.2.3` would update `/v/latest`, but `v2.0.0-beta.1` would not. Check out the documentation for [node-semver](https://github.com/npm/node-semver) for the exact details on what constitutes a prerelease version.
+Note that this only applies to non-prerelease tags, so `v1.2.3` would update the root app, but `v2.0.0-beta.1` would not. Check out the documentation for [node-semver](https://github.com/npm/node-semver) for the exact details on what constitutes a prerelease version.
 
 ### Branch deploys
 
-When you deploy from a commit at the head of a branch that _doesn't_ have a tag associated with it, the compiled app will land in a folder named after that branch, as in our "getting started" example above. Unlike tag deploys, branch deploys will never automatically update `/v/latest`.
+When you deploy from a commit at the head of a branch that _doesn't_ have a tag associated with it, the compiled app will land in a folder named after that branch, as in our "getting started" example above. Unlike tag deploys, branch deploys will never automatically update the root app.
 
-The main use case for branch deploys is tracking development work since your last stable release. If you run `ember deploy` after successful builds on `master`, you'll always have documentation available for the bleeding edge of your addon's features. Since branch deploys don't update `/v/latest`, though, developers looking at your docs will still hit your most recent stable tag by default, so there won't be any confusion about things that have drifted since the last release.
+The main use case for branch deploys is tracking development work since your last stable release. If you run `ember deploy` after successful builds on `master`, you'll always have documentation available for the bleeding edge of your addon's features. Since branch deploys don't update the root, though, developers looking at your docs will still hit your most recent stable tag by default, so there won't be any confusion about things that have drifted since the last release.
 
 ## Automating deploys
 
@@ -134,7 +132,7 @@ This method returns a name for a given version of your documentation. By default
 
 ### `shouldUpdateLatest()`
 
-This method determines whether the `/v/latest` directory will also be updated with the current deploy. By default, this will return true for builds from a tagged commit where the tag is a [semver non-prerelease version](https://github.com/npm/node-semver), and false otherwise. You can explicitly set the `ADDON_DOCS_UPDATE_LATEST` environment variable to `true` or `false` to override this behavior.
+This method determines whether the root copy of your docs app will also be updated with the current deploy. By default, this will return true for builds from a tagged commit where the tag is a [semver non-prerelease version](https://github.com/npm/node-semver), and false otherwise. You can explicitly set the `ADDON_DOCS_UPDATE_LATEST` environment variable to `true` or `false` to override this behavior.
 
 ### `getRootURL()`
 

vendor/ember-cli-addon-docs/404.html

@@ -26,6 +26,12 @@
       var l = window.location;
       var segments = l.pathname.split('/');
 
+      // If we're looking at a versioned deploy, there are effectively
+      // two more static segments in the count.
+      if (segments[segmentCount + 1] === 'v') {
+        segmentCount += 2;
+      }
+
       // Avoid an infinite loop if we try to direct to a location that doesn't exist
       if (!/^\?p=\/.*&q=.*/.test(l.search)) {
         l.replace(