Skip to content

Commit

Permalink
XS⚠️ ◾ [Autogenerated] Release v1.5.10 (#452)
Browse files Browse the repository at this point in the history
Autogenerated release for PR Metrics v1.5.10.

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
  • Loading branch information
muiriswoulfe and github-actions[bot] authored Jan 8, 2024
1 parent 43071e2 commit 31949f4
Show file tree
Hide file tree
Showing 45 changed files with 3,150 additions and 12,297 deletions.
11 changes: 11 additions & 0 deletions .c8rc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"exclude": [
"tests/**/*",
"src/wrappers/**/*"
],
"check-coverage": true,
"statements": 98,
"branches": 98,
"functions": 98,
"lines": 98
}
3 changes: 3 additions & 0 deletions .github/azure-devops/template.yml
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,9 @@ stages:
os: windows
image: windows-latest
steps:
- task: ComponentGovernanceComponentDetection@0
displayName: Component Detection

- task: PoliCheck@2
displayName: PoliCheck
inputs:
Expand Down
47 changes: 28 additions & 19 deletions .github/workflows/release-phase-1-internal.yml
Original file line number Diff line number Diff line change
Expand Up @@ -152,23 +152,6 @@ jobs:
$FileContents = $FileContents[0..$Index]
Set-Content -Path $FilePath -Value $FileContents
- name: npm – Install Node.js
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
with:
node-version: 16.10.0 # The latest version with NPMv7, which is required to maintain a package-lock.json lockfileVersion of 2.

- name: npm – Install NCU
run: npm install -g npm-check-updates

- name: npm – Update Dependencies
run: ncu -u

- name: npm – Update Transitive Dependencies
run: npm update

- name: npm – Build Package
run: npm run build:package

- name: Git – Setup Authentication
run: gh auth setup-git
env:
Expand All @@ -187,7 +170,7 @@ jobs:
run: git add -A

- name: Git – Commit Changed Files
run: git commit -m "Updating dist folder"
run: git commit -m "Updating version number"

- name: Git – Push Changed Files
run: git push --set-upstream origin release/v${{ env.version }}
Expand All @@ -196,7 +179,7 @@ jobs:
run: >-
gh pr create
--title "[Autogenerated] Release v${{ env.version }}"
--body "Autogenerated release for PR Metrics v${{ env.version }}."
--body "Autogenerated release for PR Metrics v${{ env.version }}. This includes the latest dependency updates."
--label "release"
--assignee "${{ github.actor }}"
--reviewer "${{ github.actor }}"
Expand All @@ -210,4 +193,30 @@ jobs:
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: npm – Install Node.js
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
with:
node-version: 16.10.0 # The latest version with NPMv7, which is required to maintain a package-lock.json lockfileVersion of 2.

- name: npm – Install NCU
run: npm install -g npm-check-updates

- name: npm – Update Dependencies
run: ncu -u

- name: npm – Update Transitive Dependencies
run: npm update

- name: npm – Build Package
run: npm run build:package

- name: Git – Add Changed Files
run: git add -A

- name: Git – Commit Changed Files
run: git commit -m "Updating dependencies"

- name: Git – Push Changed Files
run: git push --set-upstream origin release/v${{ env.version }}

...
4 changes: 2 additions & 2 deletions .github/workflows/release-phase-1.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ on:
required: true
type: string
patch:
default: '10'
default: '11'
description: The patch element of the version number
required: true
type: string
Expand All @@ -38,6 +38,6 @@ jobs:
with:
major: ${{ inputs.major || 1 }}
minor: ${{ inputs.minor || 5 }}
patch: ${{ inputs.patch || 10 }}
patch: ${{ inputs.patch || 11 }}

...
2 changes: 1 addition & 1 deletion .github/workflows/support/release-trigger.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.5.9
1.5.10
13 changes: 0 additions & 13 deletions .nycrc.json

This file was deleted.

4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ The default input values are expected to be appropriate for most builds.
Therefore, the following YAML definition is recommended:

```YAML
uses: microsoft/[email protected].9
uses: microsoft/[email protected].10
name: PR Metrics
env:
PR_METRICS_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand All @@ -123,7 +123,7 @@ continue-on-error: true
If you wish to modify the inputs, YAML akin the to the following can be used:

```YAML
uses: microsoft/[email protected].9
uses: microsoft/[email protected].10
name: PR Metrics
env:
PR_METRICS_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand Down
50 changes: 22 additions & 28 deletions dist/index.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dist/resources.resjson
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"$schema": "https://json.schemastore.org/resjson.json",
"loc.description": "Augments pull request titles to let reviewers quickly determine PR size and test coverage.",
"loc.description.comment": "The description of the task.",
"loc.friendlyName": "PR Metrics v1.5.9",
"loc.friendlyName": "PR Metrics v1.5.10",
"loc.friendlyName.comment": "The name of the task.",
"loc.helpMarkDown": "[More information](https://aka.ms/PRMetrics/README)",
"loc.helpMarkDown.comment": "The Markdown-formatted help text of the task.",
Expand Down
11 changes: 5 additions & 6 deletions docs/cross-platform-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,10 @@ insulate the top-level code from the need to manage API differences.
## Building the Code

Further issues arise during the building of the code. The GitHub runner uses
relatively recent versions of Node.js, with plans
[to migrate from Node.js v12 to Node.js v16 by Summer 2023][nodejsmigration].
The Azure DevOps runner currently only uses Node.js v10.24.1. v10 does not
support all recent ECMAScript features, which creates a problem for some
dependencies.
relatively recent versions of Node.js, with
[Node.js v16 is use since July 2023][nodejsmigration]. The in-built Azure DevOps
runner only uses Node.js v10.24.1. v10 does not support all recent ECMAScript
features, which creates a problem for some dependencies.

In particular, the [`@octokit/oauth-app`][octokitoauthapp] package, which is an
indirect dependency of the Octokit APIs, uses ECMAScript constructs that will
Expand Down Expand Up @@ -64,6 +63,6 @@ more modern and code sizes smaller.

[babel]: https://babeljs.io/
[ncc]: https://www.npmjs.com/package/@vercel/ncc
[nodejsmigration]: https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/
[nodejsmigration]: https://github.blog/changelog/2023-07-17-github-actions-removal-of-node12-from-the-actions-runner/
[octokitgitdiffparser]: ../src/task/src/git/octokitGitDiffParser.ts
[octokitoauthapp]: https://www.npmjs.com/package/@octokit/oauth-app
9 changes: 4 additions & 5 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,10 @@ interfaces to add additional methods, while retaining the same access pattern.
## Testing

This task is tested via unit tests constructed using the [Mocha][mocha] test
framework, the [Chai][chai] assertion library and the [ts-mockito][tsmockito]
mocking library. Tests follow the [Arrange-Act-Assert pattern][aaa], and they
can be run using `npm test` from within the `src/task` folder. This command will
output both the test results and code coverage metrics.
framework and the [ts-mockito][tsmockito] mocking library. Tests follow the
[Arrange-Act-Assert pattern][aaa], and they can be run using `npm test` from
within the `src/task` folder. This command will output both the test results and
code coverage metrics.

The code coverage is currently extremely high, and a high rate of coverage
should be maintained for all changes. There are a large number of edge cases
Expand Down Expand Up @@ -124,7 +124,6 @@ outputted by default irrespective of the value of the `system.debug` variable.
[npm]: https://www.npmjs.com/
[tfxpat]: https://docs.microsoft.com/azure/devops/extend/publish/command-line
[mocha]: https://mochajs.org/
[chai]: https://www.chaijs.com/
[tsmockito]: https://github.com/NagRock/ts-mockito
[aaa]: https://automationpanda.com/2020/07/07/arrange-act-assert-a-pattern-for-writing-good-tests/
[eslint]: https://eslint.org/
Expand Down
Loading

0 comments on commit 31949f4

Please sign in to comment.