primer / deploy Goto Github PK

Deploy to Now from GitHub Actions with useful aliases

Home Page: https://npm.im/@primer/deploy

License: MIT License

JavaScript 92.66% HCL 3.52% Dockerfile 2.20% HTML 0.91% Shell 0.70%

deploy's Introduction

primer/deploy

This GitHub Action deploys to Now and aliases the successful deployment to a predictable URL according to the following conditions:

We run now without any arguments to get the "root" deployment URL, which is generated by Now.
If the branch is master, we treat the alias field in now.json as the production URL and:
1. If there is a rules.json:
  - now alias <deployment> <name>.now.sh to create a fallback URL for path aliases
  - now alias <deployment> <production> -r rules.json to set up path aliases
2. now alias <deployment> <production> to alias the production URL.
now alias <deployment> <name>-<branch>.now.sh to alias the root deployment to a branch-specific URL.

The app name (<name>) and branch (<branch>) are both "slugified" to strip invalid characters so that they'll work as URLs. Leading non-word characters are removed, and any sequence of characters that isn't alphanumeric or - is replaced with a single -. In other words, @primer/css becomes primer-css, shawnbot/some_branch becomes shawnbot-some-branch, and so on.

Status checks

Two status checks will be listed for this action in your checks: deploy is the action's check, and deploy/alias is a commit status created by the action that reports the URL and links to it via "Details":

Note: Checks listed in the PR merge box (above) always point to the most recent commit, but you can access the list of checks for the last commit of every push by clicking on the status icon (usually a or ) in your repo's "Commits" and "Branches" pages, or commit history on a PR page:

Usage

To use this action in your own workflow, add the following snippet to your .github/main.workflow file:

action "deploy" {
  uses = "primer/deploy@master"
  secrets = [
    "GITHUB_TOKEN",
    "NOW_TOKEN",
  ]
}

You will need to provide a Zeit token value for the NOW_TOKEN secret in the Actions visual editor if you haven't already.

To avoid racking up failed deployments, we suggest that you place this action after any linting and test actions.

Now CLI arguments

It's possible to pass additional arguments through to the now CLI via the args field in your workflow action. Because the primer-deploy CLI accepts options of its own (such as --dry-run), you need to prefix any now arguments with --:

action "deploy" {
  uses = "primer/deploy@master"
+  args = "-- --meta autoDeployed=true"

You can also use args to deploy a subdirectory, e.g. docs:

action "deploy" {
  uses = "primer/deploy@master"
+  args = "-- docs"

deploy's People

Contributors

Stargazers

Watchers

Forkers

zenkbaries cherishsince nikgraf ikigai-gh herbertfonzar pablolibo 3v1lw1th1n malwr-io isabella232 seanpm2001

deploy's Issues

Deprecate this action 💀

A lot has changed with Now's GitHub integration since we made this action, and it does all of the things we do. As we migrate our repos from Now v1 to v2, we need to also remove this action from our workflows and add them to the list in our installed app settings. Here's the playbook for migrating:

Add the repo in the Now app settings (private, behind sudo auth).
Delete any actions with uses = "primer/deploy@..." in .github/main.workflow, and remove that action's name from any needs = [...] prerequisites in other actions.
Commit those changes to a new branch and create a PR so that you can see what happens and fix any issues that come up.

That should be it! If all goes well, you'll get a comment from now[bot] with a link to the deployment. If the repo you're updating is on Now v2 (if it has version: 2 in now.json), you'll get an alias URL for the most recent deployment in the form {project}-git-{branch}.primer.now.sh. ✨

Note that migration URLs are still available in the status checks list for each push, but the integration uses our Deployments API and closes #7.

Repos to migrate

primer/blueprints (underway in primer/blueprints#43)
primer/css (done in primer/css#809)
primer/components
primer/design
primer/g-octicon (underway in primer/g-octicon#14)
primer/presentations
primer/primer.style

Docs to update

primer/actions (this repo can probably be deleted if we're only using primer/publish everywhere)

Deploying to Now V2

Is it possible to use this action to deploy to Now V2?

Run now with `--no-verify`

We've been having issues with the Now CLI timing out, and it looks like there are a couple of fixes:

Reduce the scale numbers so that Now doesn't have to verify instantiation of as many instances in different regions.
Run now --no-verify the first time to skip the instantiation check.

Unfortunately we can't test this with args = ["--", "--no-verify"] because now alias barfs on the --no-verify flag.

Use the deployments API?

Deployments would allow us to move links for the deployed site out of status checks and into the area above the PR merge box:

Based on my brief skimming, it looks like we would create a deployment with the API from this action and base the "environment" on branch (maybe development for "root" deployments and branch aliases, staging for release candidates, and production on master?), let GitHub sort out the required status checks, then we'd be on the hook for running something that gets the deployment event, actually does the deployment (running now), then reports back status.

I think that we can respond to the deployment event in Actions, which would mean that maybe we have a on = "deployment" workflow that runs a different action than the one that creates the deployment, in which case we wouldn't have to run a server that gets the webhooks? I dunno, the more I write about it the less convinced I am that this is worth doing. 🤔

/cc @jonrohan

primer/components fails with cryptic error

You can see in this run and this log that the action is failing with:

deploy error: Error: Unable to get deployment URL from now:

I noticed in the log of the previous successful run that it was running @primer/[email protected], so I pinned it with primer/[email protected] and that worked.

So the question is, what changed between 2.0.0 and 2.2.0 that would cause this? /cc @emplums

$ now alias deprecated

On 3/19/19, a new version of Now was released which unfortunately deprecates the alias subcommand.

Instead they have replaced it with a simpler but less powerful feature called "Automatic Aliasing".

https://zeit.co/blog/automatic-aliasing

That said, I do not see any mention of the POST aliases endpoint being deprecated from the v2 API. 🤔

https://zeit.co/docs/api/#endpoints/aliases/assign-an-alias-to-a-deployment

I'm wondering if this action will need to be updated?

Run now from this repo's working dir, not via npx

Currently we run the Now CLI with npx now <args>, which presents some issues:

Each repo is responsible for having now as a (dev) dependency, and may use a version that are "incompatible" with the assumptions we make here.
As seen in this failed run, if npx has to install now at runtime it'll fail because it's running as root, which prevents lifecycle hooks like postinstall from running, and it looks to me from that error that now relies on those.

So instead of running npx now, we should have now as a dependency in this repo and get its CLI path locally, i.e. ./node_modules/.bin/now.

The only downside to this is that repos can't spec their own Now CLI version, but being able to upgrade it consistently across our repos by pinning a version of this action feels more sustainable to me.