Skip to content

Commit

Permalink
Merge pull request #87 from 10up/repo-rename
Browse files Browse the repository at this point in the history
Release/2.0.0 and Rename to "repo-automator"
  • Loading branch information
iamdharmesh authored Aug 21, 2023
2 parents 96cffdd + 1caf7d3 commit 53657e7
Show file tree
Hide file tree
Showing 8 changed files with 68 additions and 35 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
name: 'PR Automator'
name: 'Repo Automator'
on:
issues:
types:
- opened
push:
branches:
- develop
pull_request:
types:
- opened
Expand All @@ -13,10 +19,13 @@ jobs:
Validate:
runs-on: ubuntu-latest
steps:
- uses: 10up/action-pr-automator@develop
- uses: 10up/action-repo-automator@develop
with:
fail-label: needs:feedback
pass-label: needs:code-review
reviewer: iamdharmesh
reviewers: |
iamdharmesh
team:open-source-practice
sync-pr-branch: true
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
36 changes: 30 additions & 6 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,42 @@ All notable changes to this project will be documented in this file, per [the Ke

## [Unreleased] - TBD

## [2.0.0] - 2023-08-XX
**Note that this release renames action to "Repo Automator"**

### Added
- Support for automatically add a milestone. (props [@iamdharmesh](https://github.com/iamdharmesh), [@jeffpaul](https://github.com/jeffpaul), [@faisal-alvi](https://github.com/faisal-alvi) via [#47](https://github.com/10up/action-pr-automator/pull/47))
- Support for request PR review from multiple reviewers. (props [@iamdharmesh](https://github.com/iamdharmesh), [@faisal-alvi](https://github.com/faisal-alvi), [@jeffpaul](https://github.com/jeffpaul) via [#48](https://github.com/10up/action-pr-automator/pull/48))
- Support for auto-assigning issues to PR author. (props [@iamdharmesh](https://github.com/iamdharmesh), [@jeffpaul](https://github.com/jeffpaul), [@faisal-alvi](https://github.com/faisal-alvi) via [#49](https://github.com/10up/action-pr-automator/pull/49))
- Support for notify merge conflict (props [@iamdharmesh](https://github.com/iamdharmesh), [@dkotter](https://github.com/dkotter) via [#72](https://github.com/10up/action-pr-automator/pull/72))
- Support for welcome first-time contributors (props [@iamdharmesh](https://github.com/iamdharmesh), [@jeffpaul](https://github.com/jeffpaul), [@ravinderk](https://github.com/ravinderk) via [#82](https://github.com/10up/action-pr-automator/pull/82))
- Support auto-comment on new issues and pull requests (props [@iamdharmesh](https://github.com/iamdharmesh), [@jeffpaul](https://github.com/jeffpaul), [@ravinderk](https://github.com/ravinderk) via [#83](https://github.com/10up/action-pr-automator/pull/83))
- Support for auto-sync PR branch. (props [@iamdharmesh](https://github.com/iamdharmesh), [@ravinderk](https://github.com/ravinderk) via [#81](https://github.com/10up/action-pr-automator/pull/81))
- Support for passing pull request validation regex from workflow file. (props [@senhordaluz](https://github.com/senhordaluz), [@iamdharmesh](https://github.com/iamdharmesh), [@Sidsector9](https://github.com/Sidsector9) via [#84](https://github.com/10up/action-pr-automator/pull/84))

### Changed
- Renamed `reviewer` configuration field to `reviewers`. (props [@iamdharmesh](https://github.com/iamdharmesh), [@faisal-alvi](https://github.com/faisal-alvi), [@jeffpaul](https://github.com/jeffpaul) via [#48](https://github.com/10up/action-pr-automator/pull/48))
- Rename action to "Repo Automator" (props [@iamdharmesh](https://github.com/iamdharmesh), [@jeffpaul](https://github.com/jeffpaul) via [#87](https://github.com/10up/action-repo-automator/pull/87))

### Security
- Bump `@octokit/action` from 4.0.9 to 6.0.5 (props [@dependabot[bot]](https://github.com/apps/dependabot), [@jeffpaul](https://github.com/jeffpaul), [@iamdharmesh](https://github.com/iamdharmesh) via [#30](https://github.com/10up/action-pr-automator/pull/30), [#40](https://github.com/10up/action-pr-automator/pull/40), [#60](https://github.com/10up/action-pr-automator/pull/60), [#62](https://github.com/10up/action-pr-automator/pull/62), [#64](https://github.com/10up/action-pr-automator/pull/64), [#66](https://github.com/10up/action-pr-automator/pull/66), [#69](https://github.com/10up/action-pr-automator/pull/69), [#78](https://github.com/10up/action-pr-automator/pull/78))
- Bump `@vercel/ncc` from 0.34.0 to 0.36.1 (props [@dependabot[bot]](https://github.com/apps/dependabot), [@jeffpaul](https://github.com/jeffpaul), [@iamdharmesh](https://github.com/iamdharmesh) via [#35](https://github.com/10up/action-pr-automator/pull/35), [#41](https://github.com/10up/action-pr-automator/pull/41))
- Bump `actions/setup-node` from 3.5.1 to 3.8.0 (props [@dependabot[bot]](https://github.com/apps/dependabot), [@jeffpaul](https://github.com/jeffpaul), [@iamdharmesh](https://github.com/iamdharmesh) via [#38](https://github.com/10up/action-pr-automator/pull/38), [#71](https://github.com/10up/action-pr-automator/pull/71), [#89](https://github.com/10up/action-pr-automator/pull/89))
- Bump `eslint` from 8.25.0 to 8.47.0 (props [@dependabot[bot]](https://github.com/apps/dependabot), [@jeffpaul](https://github.com/jeffpaul), [@iamdharmesh](https://github.com/iamdharmesh) via [#31](https://github.com/10up/action-pr-automator/pull/31), [#32](https://github.com/10up/action-pr-automator/pull/32), [#33](https://github.com/10up/action-pr-automator/pull/33), [#34](https://github.com/10up/action-pr-automator/pull/34), [#36](https://github.com/10up/action-pr-automator/pull/36), [#37](https://github.com/10up/action-pr-automator/pull/37), [#39](https://github.com/10up/action-pr-automator/pull/39), [#42](https://github.com/10up/action-pr-automator/pull/42), [#50](https://github.com/10up/action-pr-automator/pull/50), [#53](https://github.com/10up/action-pr-automator/pull/53), [#54](https://github.com/10up/action-pr-automator/pull/54), [#55](https://github.com/10up/action-pr-automator/pull/55), [#56](https://github.com/10up/action-pr-automator/pull/56), [#57](https://github.com/10up/action-pr-automator/pull/57), [#58](https://github.com/10up/action-pr-automator/pull/58), [#61](https://github.com/10up/action-pr-automator/pull/61), [#65](https://github.com/10up/action-pr-automator/pull/65), [#67](https://github.com/10up/action-pr-automator/pull/67), [#70](https://github.com/10up/action-pr-automator/pull/70), [#75](https://github.com/10up/action-pr-automator/pull/75), [#86](https://github.com/10up/action-pr-automator/pull/86), [#88](https://github.com/10up/action-pr-automator/pull/88))

## [1.0.1] - 2022-10-14
### Changed
- Rename action to "PR Automator" (props [@iamdharmesh](https://github.com/iamdharmesh), [@jeffpaul](https://github.com/jeffpaul) via [#27](https://github.com/10up/action-pr-automator/pull/27))
- Rename action to "PR Automator" (props [@iamdharmesh](https://github.com/iamdharmesh), [@jeffpaul](https://github.com/jeffpaul) via [#27](https://github.com/10up/action-repo-automator/pull/27))

### Security
- Bump `@octokit/action` from 4.0.8 to 4.0.9 (props [@dependabot](https://github.com/apps/dependabot) via [#25](https://github.com/10up/action-pr-automator/pull/25)).
- Bump `actions/setup-node` from 3.5.0 to 3.5.1 (props [@dependabot](https://github.com/apps/dependabot) via [#26](https://github.com/10up/action-pr-automator/pull/26)).
- Bump `@octokit/action` from 4.0.8 to 4.0.9 (props [@dependabot](https://github.com/apps/dependabot) via [#25](https://github.com/10up/action-repo-automator/pull/25)).
- Bump `actions/setup-node` from 3.5.0 to 3.5.1 (props [@dependabot](https://github.com/apps/dependabot) via [#26](https://github.com/10up/action-repo-automator/pull/26)).

## [1.0.0] - 2022-10-14
### Added
- Initial project release 🎉

[Unreleased]: https://github.com/10up/action-pr-automator/compare/trunk...develop
[1.0.1]: https://github.com/10up/action-pr-automator/compare/1.0.0..1.0.1
[1.0.0]: https://github.com/10up/action-pr-automator/releases/tag/1.0.0
[Unreleased]: https://github.com/10up/action-repo-automator/compare/trunk...develop
[2.0.0]: https://github.com/10up/action-repo-automator/compare/1.0.1..2.0.0
[1.0.1]: https://github.com/10up/action-repo-automator/compare/1.0.0..1.0.1
[1.0.0]: https://github.com/10up/action-repo-automator/releases/tag/1.0.0
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ Contributing isn't just writing code - it's anything that improves the project.

### Reporting bugs

If you're running into an issue, please take a look through [existing issues](https://github.com/10up/action-pr-automator/issues) and [open a new one](https://github.com/10up/action-pr-automator/issues/new) if needed. If you're able, include steps to reproduce, environment information, and screenshots/screencasts as relevant.
If you're running into an issue, please take a look through [existing issues](https://github.com/10up/action-repo-automator/issues) and [open a new one](https://github.com/10up/action-repo-automator/issues/new) if needed. If you're able, include steps to reproduce, environment information, and screenshots/screencasts as relevant.

### Suggesting enhancements

New features and enhancements are also managed via [issues](https://github.com/10up/action-pr-automator/issues).
New features and enhancements are also managed via [issues](https://github.com/10up/action-repo-automator/issues).

### Pull requests

Expand All @@ -36,12 +36,12 @@ The `develop` branch is the development branch which means it contains the next
6. Readme updates: Make any other readme changes as necessary.
7. Merge: Make a non-fast-forward merge from your release branch to `develop` (or merge the pull request), then do the same for `develop` into `trunk` (`git checkout trunk && git merge --no-ff develop`). `trunk` contains the stable development version.
8. Push: Push your `trunk` branch to GitHub (e.g. `git push origin trunk`).
9. Release: Create a [new release](https://github.com/10up/action-pr-automator/releases/new), naming the tag and the release with the new version number, and targeting the `trunk` branch. Paste the changelog from `CHANGELOG.md` into the body of the release and include a link to the closed issues on the [milestone](https://github.com/10up/action-pr-automator/milestone/#?closed=1).
10. Close milestone: Edit the [milestone](https://github.com/10up/action-pr-automator/milestone/#) with release date (in the `Due date (optional)` field) and link to GitHub release (in the `Description` field), then close the milestone.
9. Release: Create a [new release](https://github.com/10up/action-repo-automator/releases/new), naming the tag and the release with the new version number, and targeting the `trunk` branch. Paste the changelog from `CHANGELOG.md` into the body of the release and include a link to the closed issues on the [milestone](https://github.com/10up/action-repo-automator/milestone/#?closed=1).
10. Close milestone: Edit the [milestone](https://github.com/10up/action-repo-automator/milestone/#) with release date (in the `Due date (optional)` field) and link to GitHub release (in the `Description` field), then close the milestone.
11. Punt incomplete items: If any open issues or PRs which were milestoned for `X.Y.Z` do not make it into the release, update their milestone to `X.Y.Z+1`, `X.Y+1.0`, `X+1.0.0` or `Future Release`.

### What to do if things go wrong

If you run into issues during the release process and things have NOT fully deployed to WordPress.org / npm / whatever external-to-GitHub location that we might be publishing to, then the best thing to do will be to delete any Tag (e.g., https://github.com/10up/action-pr-automator/releases/tag/TAGNAME) or Release that's been created, research what's wrong, and once things are resolved work on re-tagging and re-releasing on GitHub and publishing externally where needed.
If you run into issues during the release process and things have NOT fully deployed to WordPress.org / npm / whatever external-to-GitHub location that we might be publishing to, then the best thing to do will be to delete any Tag (e.g., https://github.com/10up/action-repo-automator/releases/tag/TAGNAME) or Release that's been created, research what's wrong, and once things are resolved work on re-tagging and re-releasing on GitHub and publishing externally where needed.

If you run into issues during the release process and things HAVE deployed to WordPress.org / npm / whatever external-to-GitHub location that we might be publishing to, then the best thing to do will be to research what's wrong and once things are resolved work on a patch release and tag on GitHub and publishing externally where needed. At the top of the changelog / release notes it's best to note that its a hotfix to resolve whatever issues were found after the previous release.
2 changes: 1 addition & 1 deletion CREDITS.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The following individuals are responsible for curating the list of issues, respo

Thank you to all the people who have already contributed to this repository via bug reports, code, design, ideas, project management, translation, testing, etc.

[Dharmesh Patel (@iamdharmesh)](https://github.com/iamdharmesh), [Jeffrey Paul (@jeffpaul)](https://github.com/jeffpaul), [Siddharth Thevaril (@Sidsector9)](https://github.com/Sidsector9).
[Dharmesh Patel (@iamdharmesh)](https://github.com/iamdharmesh), [Jeffrey Paul (@jeffpaul)](https://github.com/jeffpaul), [Siddharth Thevaril (@Sidsector9)](https://github.com/Sidsector9), [Faisal Alvi (@faisal-alvi)](https://github.com/faisal-alvi), [Darin Kotter (@dkotter)](https://github.com/dkotter), [Ravinder Kumar (@ravinderk)](https://github.com/ravinderk), [Pedro da Luz (@senhordaluz)](https://github.com/senhordaluz), [Dependabot (@dependabot[bot])](https://github.com/apps/dependabot)

## Libraries

Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# PR Automator - GitHub Action
# Repo Automator - GitHub Action

> GitHub Action that automates some common PR operations like validating PR description, changelog and credits.
> GitHub Action that automates some common repository operations like validating PR description, changelog and credits.
[![Support Level](https://img.shields.io/badge/support-beta-blueviolet.svg)](#support-level) [![Release Version](https://img.shields.io/github/release/10up/action-pr-automator.svg)](https://github.com/10up/action-pr-automator/releases/latest) [![License](https://img.shields.io/github/license/10up/action-pr-automator.svg)](https://github.com/10up/action-pr-automator/blob/develop/LICENSE.md) [![CodeQL](https://github.com/10up/action-pr-automator/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/10up/action-pr-automator/actions/workflows/codeql-analysis.yml)
[![Support Level](https://img.shields.io/badge/support-beta-blueviolet.svg)](#support-level) [![Release Version](https://img.shields.io/github/release/10up/action-repo-automator.svg)](https://github.com/10up/action-repo-automator/releases/latest) [![License](https://img.shields.io/github/license/10up/action-repo-automator.svg)](https://github.com/10up/action-repo-automator/blob/develop/LICENSE.md) [![CodeQL](https://github.com/10up/action-repo-automator/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/10up/action-repo-automator/actions/workflows/codeql-analysis.yml)

## Overview

Expand Down Expand Up @@ -53,10 +53,10 @@ This GitHub Action Helps with the following operations:

## Example Workflow File

To get started, you will want to copy the contents of the given example into `.github/workflows/pr-automator.yml` and push that to your repository. You are welcome to name the file something else.
To get started, you will want to copy the contents of the given example into `.github/workflows/repo-automator.yml` and push that to your repository. You are welcome to name the file something else.

```yml
name: 'PR Automator'
name: 'Repo Automator'
on:
issues:
types:
Expand All @@ -78,7 +78,7 @@ jobs:
Validate:
runs-on: ubuntu-latest
steps:
- uses: 10up/action-pr-automator@trunk
- uses: 10up/action-repo-automator@trunk
with:
fail-label: 'needs:feedback'
pass-label: 'needs:code-review'
Expand Down Expand Up @@ -126,11 +126,11 @@ __Merge Conflicts__ - Sometimes, GitHub does not reliably compute the [`mergeabl

## Changelog

A complete listing of all notable changes to PR Automator - GitHub Action are documented in [CHANGELOG.md](https://github.com/10up/action-pr-automator/blob/develop/CHANGELOG.md).
A complete listing of all notable changes to Repo Automator - GitHub Action are documented in [CHANGELOG.md](https://github.com/10up/action-repo-automator/blob/develop/CHANGELOG.md).

## Contributing

Please read [CODE_OF_CONDUCT.md](https://github.com/10up/action-pr-automator/blob/develop/CODE_OF_CONDUCT.md) for details on our code of conduct, [CONTRIBUTING.md](https://github.com/10up/action-pr-automator/blob/develop/CONTRIBUTING.md) for details on the process for submitting pull requests to us, and [CREDITS.md](https://github.com/10up/action-pr-automator/blob/develop/CREDITS.md) for a list of maintainers, contributors, and libraries used in this repository.
Please read [CODE_OF_CONDUCT.md](https://github.com/10up/action-repo-automator/blob/develop/CODE_OF_CONDUCT.md) for details on our code of conduct, [CONTRIBUTING.md](https://github.com/10up/action-repo-automator/blob/develop/CONTRIBUTING.md) for details on the process for submitting pull requests to us, and [CREDITS.md](https://github.com/10up/action-repo-automator/blob/develop/CREDITS.md) for a list of maintainers, contributors, and libraries used in this repository.

## Like what you see?

Expand Down
4 changes: 2 additions & 2 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: "PR Automator"
description: "GH Action for automate some common PR operations and validate PR description, changelog and credits."
name: "Repo Automator"
description: "GH Action for automate some common repository operations and validate PR description, changelog and credits."
branding:
icon: "git-branch"
color: "blue"
Expand Down
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"name": "10up/action-pr-automator",
"version": "1.0.1",
"description": "GitHub Action to automate some common PR operations and validate PR description, changelog and credits.",
"name": "10up/action-repo-automator",
"version": "2.0.0",
"description": "GitHub Action to automate some common repository operations and validate PR description, changelog and credits.",
"keywords": [
"GitHub",
"Actions",
"JavaScript"
],
"homepage": "https://github.com/10up/action-pr-automator#readme",
"homepage": "https://github.com/10up/action-repo-automator#readme",
"bugs": {
"url": "https://github.com/10up/action-pr-automator/issues"
"url": "https://github.com/10up/action-repo-automator/issues"
},
"license": "MIT",
"author": {
Expand All @@ -20,7 +20,7 @@
"main": "index.js",
"repository": {
"type": "git",
"url": "[email protected]:10up/action-pr-automator.git"
"url": "[email protected]:10up/action-repo-automator.git"
},
"scripts": {
"lint": "eslint .",
Expand Down

0 comments on commit 53657e7

Please sign in to comment.