Skip to content

🚀 Feature: Deploy docs of major releases to their own subdomains #3644

Open

Description

Currently, only the mochajs.org branch will be published whenever it's updated. That's fine for ensuring our site doesn't reflect master, but what we should really do is have multiple sites--e.g., one for v5.x and another for v6.x.

Netlify can do this automatically based on branch name; it creates a slug of the branch name and uses that for the subdomain. We can then allowlist the branches to deploy. So, I propose maintaining these branches (which map to <branch>.mochajs.org):

  • latest: Whatever release npm latest tag points to (currently v5.2.0). No subdomain; this is the "official" site
  • master: This will always reflect master
  • next: Whatever the npm next tag points to (currently v6.0.0-0)
  • v5 and v6: Pointing to two new npm tags with these respective names. Next major would be v7. We'd need to keep these branches pointing to the latest git tags for each major. This does not imply we will maintain old versions of Mocha; just that the reference material will still exist.

This will require some documentation and/or automation around publishing.

This can be setup in Netlify's UI, and I'll do it if I can get it to update our branches. but if anyone in @mochajs/core would like to help, go right ahead. if you don't have access to our Netlify site and want it, please let me know and I'll add you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    area: documentationanything involving docs or mochajs.orgcore-teamissues which must be handled by Mocha's core teamstatus: accepting prsMocha can use your help with this one!type: featureenhancement proposal

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions