# action-append-pr-description

> Append the deployment URL to GitHub's pull request description

Latest version **1.2.1** (published 2023-01-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install action-append-pr-description
pnpm add action-append-pr-description
yarn add action-append-pr-description
bun add action-append-pr-description
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.1 |
| Published | 2023-01-16 |
| First published | 2023-01-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 230.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | chabroA |
| Maintainers | achabrolin-ledger |

## Links

- npm: https://www.npmjs.com/package/action-append-pr-description
- Repository: https://github.com/chabroA/action-append-pr-description
- Issues: https://github.com/chabroA/action-append-pr-description/issues
- npm.io page: https://npm.io/package/action-append-pr-description

## Dependencies (2)

- [@actions/core](https://npm.io/package/@actions/core.md) ^1.2.6
- [@actions/github](https://npm.io/package/@actions/github.md) ^4.0.0

## Recent versions

- 1.2.1 (latest) — 2023-01-16
- 1.2.0 — 2023-01-16

## README

# action-append-pr-description

The `chabroA/action-append-pr-description` action is a JavaScript action that appends a provided deployment URL to a GitHub pull request description if not already present.

## Usage

```yaml
steps:
  - name: Add deploy URL to PR description
    uses: chabroA/action-append-pr-description@master
    with:
      auth: ${{ secrets.GITHUB_TOKEN }}
      repo: ${{ github.event.repository.name }}
      owner: ${{ github.repository_owner }}
      pr: ${{ github.event.number }}
      url: "https://my-url.test"
      message: "My url :" 
```

## Inputs

- `auth` - (required) A [GitHub Secret Token](https://docs.github.com/en/actions/reference/authentication-in-a-workflow) with access to the repository you want to update.

- `repo` - (required) The GitHub repository name containing the PR to update.

- `owner` - (required) The GitHub repository owner.

- `pr` - (required) The pull request number.

- `url` - (required) The url to append to the specified pull request description.

- `message` - (optional) The message to append before the url.

## Outputs

This action does not configure any outputs.

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

You can test the action locally by copying the code to your own repo (that uses a github workflow).

When updating the code, don't forget to run `yarn package` and commit the `dist/index.js` file since this is the one used by the action.

cf. [GitHub Docs about JavaScript action](https://docs.github.com/en/actions/creating-actions/creating-a-javascript-action)

## License

[MIT](./LICENSE.md)

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