Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/primer/deploy
Deploy to Now from GitHub Actions with useful aliases
https://github.com/primer/deploy
Last synced: about 2 months ago
JSON representation
Deploy to Now from GitHub Actions with useful aliases
- Host: GitHub
- URL: https://github.com/primer/deploy
- Owner: primer
- License: mit
- Archived: true
- Created: 2019-01-30T05:58:11.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-07-23T20:53:20.000Z (about 5 years ago)
- Last Synced: 2024-04-17T04:25:32.021Z (5 months ago)
- Language: JavaScript
- Homepage: https://npm.im/@primer/deploy
- Size: 121 KB
- Stars: 45
- Watchers: 5
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# primer/deploy
This [GitHub Action][github actions] deploys to [Now] and aliases the successful deployment to a predictable URL according to the following conditions:
1. We run `now` without any arguments to get the "root" deployment URL, which is generated by Now.
1. 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 .now.sh` to create a fallback URL for path aliases
* `now alias -r rules.json` to set up path aliases
1. `now alias ` to alias the production URL.
1. `now alias -.now.sh` to alias the root deployment to a branch-specific URL.
The app name (``) and 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][status 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:
```hcl
action "deploy" {
uses = "primer/deploy@master"
secrets = [
"GITHUB_TOKEN",
"NOW_TOKEN",
]
}
```
**You will need to provide a [Zeit token](https://zeit.co/account/tokens) 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 `--`:
```diff
action "deploy" {
uses = "primer/deploy@master"
+ args = "-- --meta autoDeployed=true"
```
You can also use `args` to deploy a subdirectory, e.g. `docs`:
```diff
action "deploy" {
uses = "primer/deploy@master"
+ args = "-- docs"
```
[now]: https://zeit.co/now
[github actions]: https://github.com/features/actions
[commit status]: https://developer.github.com/v3/repos/statuses/
[status checks]: https://help.github.com/articles/about-status-checks/