https://github.com/radcortez/milestone-review-action

https://github.com/radcortez/milestone-review-action

Last synced: about 20 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/radcortez/milestone-review-action
• Owner: radcortez
• Created: 2020-02-27T16:52:06.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-02-16T17:42:34.000Z (10 months ago)
• Last Synced: 2024-10-28T15:25:02.145Z (about 2 months ago)
• Language: JavaScript
• Size: 1.98 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Milestone Review action

This action checks if the project has a Milestone and if all the issues associated with the Milestone are closed. The 

main purpose is to help with preparation for the project release:

- Does the project has a milestone for the version you want to release?

- Do you have any open issues in the project?

If the answer to any of these checks is *Yes*, then the action will submit a Pull Request review to fix the issue.

This action is only intended to run with Pull Request events.  

## Inputs

### `github-token`

**Required** The GitHub Token used to create an authenticated client. The Github Token is already set by the Github 

Action itself. Use this if you want to pass in your own Personal Access Token. 

**Default** `${{github.token}}`.

### `milestone-title`

**Required** The Milestone Title to search for in the Repository.

## Example usage

```yaml

- uses: radcortez/milestone-review-action@main

  name: milestone review

  with:

    github-token: ${{secrets.GITHUB_TOKEN}}

    milestone-title: '2.0.0'

```

Most likely you want for the `milestone-title` to be dynamic. You could retrieve the milestone title associated with 

your context, by querying something in your project that provides you that information and then pass it as a variable:

```yaml

- uses: radcortez/milestone-review-action@main

  name: milestone review

  with:

    github-token: ${{secrets.GITHUB_TOKEN}}

    milestone-title: ${{steps.version.outputs.project-version}}

```