diff --git a/.github/workflows/pr-helper.yml b/.github/workflows/pr-automator.yml similarity index 85% rename from .github/workflows/pr-helper.yml rename to .github/workflows/pr-automator.yml index 8a35049..c56d7e5 100644 --- a/.github/workflows/pr-helper.yml +++ b/.github/workflows/pr-automator.yml @@ -1,4 +1,4 @@ -name: 'PR Helper' +name: 'PR Automator' on: pull_request: types: @@ -13,7 +13,7 @@ jobs: Validate: runs-on: ubuntu-latest steps: - - uses: 10up/action-pr-helper@develop + - uses: 10up/action-pr-automator@develop with: fail-label: needs:feedback pass-label: needs:code-review diff --git a/CHANGELOG.md b/CHANGELOG.md index 2e6befd..974bb33 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,6 @@ All notable changes to this project will be documented in this file, per [the Ke ### Added - Initial project release 🎉 -[Unreleased]: https://github.com/10up/action-pr-helper/compare/trunk...develop -[1.0.1]: https://github.com/10up/action-pr-helper/compare/1.0.0..1.0.1 -[1.0.0]: https://github.com/10up/action-pr-helper/releases/tag/1.0.0 \ No newline at end of file +[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 \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ddbbe5e..63819e2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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-helper/issues) and [open a new one](https://github.com/10up/action-pr-helper/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-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. ### Suggesting enhancements -New features and enhancements are also managed via [issues](https://github.com/10up/action-pr-helper/issues). +New features and enhancements are also managed via [issues](https://github.com/10up/action-pr-automator/issues). ### Pull requests @@ -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-helper/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-helper/milestone/#?closed=1). -10. Close milestone: Edit the [milestone](https://github.com/10up/action-pr-helper/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-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. 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-helper/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-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 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. diff --git a/README.md b/README.md index b6fa5c5..50b4f79 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# PR Helper - GitHub Action +# PR Automator - GitHub Action > GitHub Action that automates some common PR 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-helper.svg)](https://github.com/10up/action-pr-helper/releases/latest) [![License](https://img.shields.io/github/license/10up/action-pr-helper.svg)](https://github.com/10up/action-pr-helper/blob/develop/LICENSE.md) [![CodeQL](https://github.com/10up/action-pr-helper/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/10up/action-pr-helper/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-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) ## Overview This GitHub Action Helps with the following operations: @@ -29,10 +29,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-helper.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/pr-automator.yml` and push that to your repository. You are welcome to name the file something else. ```yml -name: 'PR Helper' +name: 'PR Automator' on: pull_request: types: @@ -47,7 +47,7 @@ jobs: Validate: runs-on: ubuntu-latest steps: - - uses: 10up/action-pr-helper@trunk + - uses: 10up/action-pr-automator@trunk with: fail-label: 'needs:feedback' pass-label: 'needs:code-review' @@ -75,11 +75,11 @@ env: ## Changelog -A complete listing of all notable changes to PR Helper - GitHub Action are documented in [CHANGELOG.md](https://github.com/10up/action-pr-helper/blob/develop/CHANGELOG.md). +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). ## Contributing -Please read [CODE_OF_CONDUCT.md](https://github.com/10up/action-pr-helper/blob/develop/CODE_OF_CONDUCT.md) for details on our code of conduct, [CONTRIBUTING.md](https://github.com/10up/action-pr-helper/blob/develop/CONTRIBUTING.md) for details on the process for submitting pull requests to us, and [CREDITS.md](https://github.com/10up/action-pr-helper/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-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. ## Like what you see? diff --git a/action.yml b/action.yml index e7cec40..9a0299a 100644 --- a/action.yml +++ b/action.yml @@ -1,5 +1,8 @@ -name: 'PR Helper' +name: 'PR Automator' description: 'GH Action for automate some common PR operations and validate PR description, changelog and credits.' +branding: + icon: 'git-branch' + color: 'blue' inputs: assign-pr: description: "Wether assign PR to reporter" diff --git a/package-lock.json b/package-lock.json index 1555e33..3066d8a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,11 +1,11 @@ { - "name": "10up/action-pr-helper", + "name": "10up/action-pr-automator", "version": "1.0.0", "lockfileVersion": 2, "requires": true, "packages": { "": { - "name": "10up/action-pr-helper", + "name": "10up/action-pr-automator", "version": "1.0.0", "license": "MIT", "dependencies": { diff --git a/package.json b/package.json index 8b30d30..9fcff26 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "10up/action-pr-helper", + "name": "10up/action-pr-automator", "version": "1.0.0", "description": "GitHub Action to automate some common PR operations and validate PR description, changelog and credits.", "keywords": [ @@ -7,9 +7,9 @@ "Actions", "JavaScript" ], - "homepage": "https://github.com/10up/action-pr-helper#readme", + "homepage": "https://github.com/10up/action-pr-automator#readme", "bugs": { - "url": "https://github.com/10up/action-pr-helper/issues" + "url": "https://github.com/10up/action-pr-automator/issues" }, "license": "MIT", "author": { @@ -20,7 +20,7 @@ "main": "index.js", "repository": { "type": "git", - "url": "git@github.com:10up/action-pr-helper.git" + "url": "git@github.com:10up/action-pr-automator.git" }, "scripts": { "lint": "eslint .",