# sfds-publish

> This [GitHub Action][github actions] publishes to npm with the following conventions:

Latest version **0.0.0** (published 2021-01-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install sfds-publish
pnpm add sfds-publish
yarn add sfds-publish
bun add sfds-publish
```

Provides the command `primer-publish`.

## Health

**Score 5/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: insecure dependencies; abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.0 |
| Published | 2021-01-14 |
| First published | 2021-01-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 28.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | shawnbot |
| Keywords | publish, github-actions, npm |

## Links

- npm: https://www.npmjs.com/package/sfds-publish
- npm.io page: https://npm.io/package/sfds-publish

## Dependencies (4)

- [yargs](https://npm.io/package/yargs.md) ^12.0.5
- [@octokit/rest](https://npm.io/package/@octokit/rest.md) ^16.15.0
- [action-status](https://npm.io/package/action-status.md) ^0.1.1
- [github-action-meta](https://npm.io/package/github-action-meta.md) github:shawnbot/github-action-meta#fix-null-branch

## Recent versions

- 0.0.0 (latest) — 2021-01-14

## README

# primer/publish

This [GitHub Action][github actions] publishes to npm with the following conventions:

1. If we're on the default branch, the `version` field is used as-is and we just run `npm publish --access public`.
   - After publishing a new version on the default branch, we tag the commit SHA with `v{version}` via the GitHub API.
   - If the version in `package.json` is already published, we exit with a `0` code. Previously, we exited with a `78` code, which was Actions v1-speak for "neutral", but this has been [removed from Actions v2](https://twitter.com/ethomson/status/1163899559279497217?s=20).
1. If we're on a `release-<version>` branch, we publish a release candidate to the `next` npm dist-tag with the version in the form: `<version>-rc.<sha>`.
   - A [status check][status checks] is created with the context `npm version` noting whether the `version` field in `package.json` matches the `<version>` portion of the branch. If it doesn't, the check's status is marked as pending.
1. Otherwise, we publish a "canary" release, which has a version in the form: `0.0.0-<sha>`.

## Status checks

Depending on the branch, a series of [statuses][status checks] will be created by this action in your checks: **publish** is the action's check, and **publish {package-name}** is a [commit status] created by the action that reports the version published and links to `unpkg.com` via "Details":

![image](https://user-images.githubusercontent.com/113896/52375286-23368980-2a14-11e9-8974-062a3e45a846.png)

If you're on a release branch (`release-<version>`) and the `<version>` portion of the branch name doesn't match the `version` field in `package.json`, you'll get a pending status reminding you to update it:

![image](https://user-images.githubusercontent.com/113896/52388530-b63ae800-2a43-11e9-92ef-14ec9459c109.png)

## Usage

**You will need to provide an npm access token with publish permissions via the `NPM_AUTH_TOKEN` secret in the Actions visual editor** if you haven't already. The `GITHUB_TOKEN` secret is also required to create tags after releasing on the master branch.

We suggest that you place this action after any linting and/or testing actions to catch as many errors as possible before publishing.


### Actions
To use this in an Actions workflow, add the following YAML to one or more of your steps:

```yaml
- uses: primer/publish@v3
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
```

You can pass additional [inputs](#inputs) via the `with` key:

```hcl
- name: Publish to the npm registry
  uses: "primer/publish@3.0.0"
  with:
    npm-args: "--unsafe-perm --allow-same-version"
    default-branch: "main"
```


## Inputs

### `dry_run`

Does everything publish would do except actually publishing to the registry. Reports the details of what would have been published.

Default: `false`

#### Example

```hcl
- name: Publish to the npm registry
  uses: "primer/publish@3.0.0"
  with:
    dry_run: true
```

### `dir`

Accepts a path to the directory that contains the `package.json` to publish.

Default: `.`

#### Example

```hcl
- name: Publish to the npm registry
  uses: "primer/publish@3.0.0"
  with:
    dir: "packages/example"
}
```

### `npm_args`

It's possible to pass additional arguments to `npm` via the `npm_args` input in your workflow action.

```hcl
- name: Publish to the npm registry
  uses: "primer/publish@3.0.0"
  with:
    npm_args: "--unsafe-perm --allow-same-version"
```

### `default_branch`

The branch you'd like to use to trigger releases. Typically this is `main` or `master`.

Default: `master`

```hcl
- name: Publish to the npm registry
  uses: "primer/publish@3.0.0"
  with:
    default_branch: "main"
```

### `release_tag`

The `release_tag` input can be used to override the auto-generated release tag.

Default: `latest`

```hcl
- name: Publish to the npm registry
  uses: "primer/publish@3.0.0"
  with:
    release_tag: "1.0.0"
```

[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/

---
_Source: https://npm.io/package/sfds-publish · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._