Merge pull request #80 from technote-space/release/next-v1.7.4

release: v1.7.5

Author: technote-space

README.ja.md

@@ -1,5 +1,44 @@
 # Auto Cancel Redundant Workflow
 
+---
+
+**Please note:** This repository is currently unmaintained by a team of developers at GitHub. The
+repository is here and you can use it as an example, or in Actions. However please be aware that
+we are not going to be updating issues or pull requests on this repository.
+
+**注意:** このリポジトリはもうメンテナンスされません。  
+代わりに公式から提供されている [concurrency](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#concurrency) を使用してください。
+
+### 移行例
+
+```yaml
+on: push
+jobs:
+  test:
+    steps:
+      - uses: technote-space/auto-cancel-redundant-workflow@v1
+      - run: echo step1
+      - run: echo step2
+      # ...
+```
+
+↓
+
+```yaml
+on: push
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+#  cancel-in-progress: true
+jobs:
+  test:
+    steps:
+      - run: echo step1
+      - run: echo step2
+      # ...
+```
+
+---
+
 [![CI Status](https://github.com/technote-space/auto-cancel-redundant-workflow/workflows/CI/badge.svg)](https://github.com/technote-space/auto-cancel-redundant-workflow/actions)
 [![codecov](https://codecov.io/gh/technote-space/auto-cancel-redundant-workflow/branch/master/graph/badge.svg)](https://codecov.io/gh/technote-space/auto-cancel-redundant-workflow)
 [![CodeFactor](https://www.codefactor.io/repository/github/technote-space/auto-cancel-redundant-workflow/badge)](https://www.codefactor.io/repository/github/technote-space/auto-cancel-redundant-workflow)

README.md

@@ -1,5 +1,40 @@
 # Auto Cancel Redundant Workflow
 
+---
+
+**Please note:** This repository is no longer maintained.  
+Please use the [concurrency](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#concurrency) provided by the officials instead.
+
+### Example of migration
+
+```yaml
+on: push
+jobs:
+  test:
+    steps:
+      - uses: technote-space/auto-cancel-redundant-workflow@v1
+      - run: echo step1
+      - run: echo step2
+      # ...
+```
+
+↓
+
+```yaml
+on: push
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+#  cancel-in-progress: true
+jobs:
+  test:
+    steps:
+      - run: echo step1
+      - run: echo step2
+      # ...
+```
+
+---
+
 [![CI Status](https://github.com/technote-space/auto-cancel-redundant-workflow/workflows/CI/badge.svg)](https://github.com/technote-space/auto-cancel-redundant-workflow/actions)
 [![codecov](https://codecov.io/gh/technote-space/auto-cancel-redundant-workflow/branch/master/graph/badge.svg)](https://codecov.io/gh/technote-space/auto-cancel-redundant-workflow)
 [![CodeFactor](https://www.codefactor.io/repository/github/technote-space/auto-cancel-redundant-workflow/badge)](https://www.codefactor.io/repository/github/technote-space/auto-cancel-redundant-workflow)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@technote-space/auto-cancel-redundant-workflow",
-  "version": "1.7.4",
+  "version": "1.7.5",
   "description": "GitHub Actions to automatically cancel redundant workflow.",
   "keywords": [
     "github",
@@ -38,31 +38,31 @@
   },
   "dependencies": {
     "@actions/core": "^1.2.7",
-    "@actions/github": "^4.0.0",
-    "@octokit/openapi-types": "^6.2.1",
+    "@actions/github": "^5.0.0",
+    "@octokit/openapi-types": "^7.0.0",
     "@octokit/plugin-paginate-rest": "^2.13.3",
     "@octokit/plugin-rest-endpoint-methods": "^5.1.1",
-    "@octokit/types": "^6.14.1",
-    "@technote-space/github-action-helper": "^5.2.6",
-    "@technote-space/github-action-log-helper": "^0.1.24"
+    "@octokit/types": "^6.14.2",
+    "@technote-space/github-action-helper": "^5.2.9",
+    "@technote-space/github-action-log-helper": "^0.1.25"
   },
   "devDependencies": {
-    "@commitlint/cli": "^12.1.1",
-    "@commitlint/config-conventional": "^12.1.1",
-    "@technote-space/github-action-test-helper": "^0.7.9",
+    "@commitlint/cli": "^12.1.4",
+    "@commitlint/config-conventional": "^12.1.4",
+    "@technote-space/github-action-test-helper": "^0.7.12",
     "@technote-space/release-github-actions-cli": "^1.8.5",
     "@types/jest": "^26.0.23",
-    "@types/node": "^15.0.1",
-    "@typescript-eslint/eslint-plugin": "^4.22.0",
-    "@typescript-eslint/parser": "^4.22.0",
-    "eslint": "^7.25.0",
+    "@types/node": "^15.3.0",
+    "@typescript-eslint/eslint-plugin": "^4.23.0",
+    "@typescript-eslint/parser": "^4.23.0",
+    "eslint": "^7.26.0",
     "husky": "^6.0.0",
     "jest": "^26.6.3",
     "jest-circus": "^26.6.3",
-    "lint-staged": "^10.5.4",
+    "lint-staged": "^11.0.0",
     "nock": "^13.0.11",
     "pinst": "^2.1.6",
-    "ts-jest": "^26.5.5",
+    "ts-jest": "^26.5.6",
     "typescript": "^4.2.4"
   },
   "publishConfig": {

src/utils/workflow.ts

@@ -1,5 +1,4 @@
 import type {OctokitResponse} from '@octokit/types';
-import type {PaginateInterface} from '@octokit/plugin-paginate-rest';
 import type {Octokit} from '@technote-space/github-action-helper/dist/types';
 import type {Context} from '@actions/github/lib/context';
 import type {Logger} from '@technote-space/github-action-log-helper';
@@ -11,7 +10,7 @@ type ActionsGetWorkflowRunResponseData = components['schemas']['workflow-run'];
 type ActionsListWorkflowRunsResponseData = components['schemas']['workflow-run'];
 
 export const getWorkflowRun = async(runId: number, octokit: Octokit, context: Context): Promise<ActionsGetWorkflowRunResponseData> => {
-  return (await octokit.actions.getWorkflowRun({
+  return (await octokit.rest.actions.getWorkflowRun({
     owner: context.repo.owner,
     repo: context.repo.repo,
     'run_id': runId,
@@ -54,8 +53,8 @@ export const getWorkflowRuns = async(workflowId: number, logger: Logger, octokit
     options.branch = branch;
   }
 
-  return (await (octokit.paginate as PaginateInterface)(
-    octokit.actions.listWorkflowRuns,
+  return (await octokit.paginate(
+    octokit.rest.actions.listWorkflowRuns,
     // eslint-disable-next-line no-warning-comments
     // TODO: remove ts-ignore after fixed types (https://github.com/octokit/types.ts/issues/122)
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
@@ -64,7 +63,7 @@ export const getWorkflowRuns = async(workflowId: number, logger: Logger, octokit
   )).map(run => run as ActionsListWorkflowRunsResponseData).filter(run => run.event === context.eventName).filter(isNotExcludeRun);
 };
 
-export const cancelWorkflowRun = async(runId: number, octokit: Octokit, context: Context): Promise<OctokitResponse<{ [key: string]: unknown; }>> => octokit.actions.cancelWorkflowRun({
+export const cancelWorkflowRun = async(runId: number, octokit: Octokit, context: Context): Promise<OctokitResponse<{ [key: string]: unknown; }>> => octokit.rest.actions.cancelWorkflowRun({
   ...context.repo,
   'run_id': runId,
 });