Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(.github/actions): add get-release-issue-v1 action #101

Merged
merged 14 commits into from
Dec 13, 2023
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions .github/actions/get-release-issue-v1/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# get-release-issue-v1

A GitHub action for getting the release issue for a release candidate.

## Inputs

| Name | Required | Description | Default |
| --------- | -------- | -------------------------------------------------------------------------------- | --------------------------- |
| `version` | Yes | The version of the release candidate | NA |
| `owner` | No | The owner of the repository e.g. dequelabs/axe-core-npm, then supply "dequelabs" | `github.context.repo.owner` |
| `repo` | No | The repository e.g. dequelabs/axe-core-npm, then supply "axe-core-npm" | `github.context.repo.repo` |

## Outputs

| Name | Description |
| ----------- | ---------------------------- |
| `issue-url` | The URL of the release issue |

## Example usage

```yaml
name: Get release issue

on:
push:
branches:
- release

jobs:
get-release-issue:
runs-on: ubuntu-latest
steps:
- uses: dequelabs/axe-api-team-public/.github/actions/get-release-issue-v1@main
id: get-release-issue
with:
version: '1.0.0'
Zidious marked this conversation as resolved.
Show resolved Hide resolved
- name: Print the release issue URL
run: echo ${{ steps.get-release-issue.outputs.issue-url }}
env:
# Required for the GH CLI
GH_TOKEN: ${{ github.token }}
```
21 changes: 21 additions & 0 deletions .github/actions/get-release-issue-v1/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: 'Get release issue'
description: 'A GitHub action for getting the release issue for a release candidate'

inputs:
version:
description: 'The version of the release candidate'
required: true
owner:
description: 'The owner of the repository e.g. dequelabs/axe-core-npm, then supply "dequelabs"'
required: false
repo:
description: 'The repository e.g. dequelabs/axe-core-npm, then supply "axe-core-npm"'
required: false

outputs:
issue-url:
description: 'The URL of the issue created for the release candidate'

runs:
using: 'node20'
main: 'dist/index.js'
1 change: 1 addition & 0 deletions .github/actions/get-release-issue-v1/dist/index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export {};
Loading