Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

XS✔ ◾ Release v1.5.10 #452

Merged
merged 26 commits into from Jan 8, 2024
Merged

XS✔ ◾ Release v1.5.10 #452

merged 26 commits into from Jan 8, 2024

Conversation

muiriswoulfe
Copy link
Member

@muiriswoulfe muiriswoulfe commented Jan 2, 2024

Autogenerated release for PR Metrics v1.5.10. This includes the latest dependency updates.

This change also includes some additional manual changes:

  • Enhancing the release pipeline to generate a PR with the version number updates, even if the dependency updates cannot be automatically applied (as was the case this month).
  • Switching from nyc to code coverage to v8 to address some incompatibilities with the latest dependency updates. This change involves, among other changes, the renaming of .nycrc.json to .c8rc.json.
  • Removal of chai in favour of in-built Node.js asserts. The latest version of chai would require use of ECMAScript modules, which conflicts with the requirements of Azure DevOps. To avoid requiring a dependency on outdated package versions, the decision was taken to move away from chai entirely.

@muiriswoulfe muiriswoulfe requested a review from a team as a code owner January 2, 2024 15:07
@muiriswoulfe muiriswoulfe added the release Updates to enable a new release label Jan 2, 2024
@muiriswoulfe muiriswoulfe self-assigned this Jan 2, 2024
Copy link
Contributor

github-actions bot commented Jan 2, 2024

Required License Update

Before completing this PR, the license information must be updated.

Note that if lockfileVersion is set to 3 (rather than 2) in package-lock.json, the license information may not be correctly generated. In this case, you will need to change lockfileVersion to 2 and rerun the build.

  1. Wait for the entire PR build to complete.

  2. Use the internal Microsoft Component Governance tooling to update src/LICENSE.txt with the automatically generated license information.

    1. At the top of the page, click main and select "Edit tracked branches".

    2. Click the wrench icon to right of refs/pull/PR_ID/merge where PR_ID is the PR number.

    3. In the flyout, select "Track this branch". Ensure the "PR" pipeline is selected. Click "Submit".

    4. At the top of the page, click microsoft/PR-Metrics to navigate back to the original page.

    5. Change the main branch to refs/pull/PR_ID/merge where PR_ID is the PR number. It is very important that this is selected correctly or the wrong license information will be generated.

    6. Use Notice > Configure to ensure that only the dependencies from package.json are included and that the devDependencies are excluded.

    7. Use Notice > Download to generate the file. Select Pipeline "PR" and Format "Plain Text". Click "Download".

    8. Add the downloaded content to the end of src/LICENSE.txt. Note that the ordering of licenses may change.

    9. If the download dialog includes any notice indicating that license information could not be located at Clearly Defined, you will need to add the information to that source. To do this, expand the drop down menu in the dialog to reveal the problematic dependencies. For each dependency:

      1. Navigate to the Clearly Defined Harvest page.
      2. In the first search box, select "NpmJS".
      3. In the second search box, select the dependency name.
      4. In the "Pick an npm version" box, select the appropriate version.
      5. Click "Harvest".

      It is also possible to add all dependencies to the page and click "Harvest" afterwards to harvest all license information simultaneously.

      Wait some time for harvesting to complete and try regenerating the license information at the Component Governance page. Repeat the process until all license information is available.

  3. Commit all the changes to your branch, updating the PR.

Copy link
Contributor

github-actions bot commented Jan 2, 2024

PR Metrics

Thanks for keeping your pull request small.
Thanks for adding tests.

Lines
Product Code 26
Test Code 716
Subtotal 742
Ignored Code 2,226
Total 2,968

Metrics computed by PR Metrics. Add it to your Azure DevOps and GitHub PRs!

@github-actions github-actions bot changed the title [Autogenerated] Release v1.5.10 XS✔ ◾ [Autogenerated] Release v1.5.10 Jan 2, 2024
@microsoft microsoft deleted a comment from github-actions bot Jan 2, 2024
@muiriswoulfe muiriswoulfe changed the title XS✔ ◾ [Autogenerated] Release v1.5.10 XS⚠️ ◾ [Autogenerated] Release v1.5.10 Jan 2, 2024
@github-actions github-actions bot changed the title XS⚠️ ◾ [Autogenerated] Release v1.5.10 XS✔ ◾ [Autogenerated] Release v1.5.10 Jan 2, 2024
@microsoft microsoft deleted a comment from github-actions bot Jan 2, 2024
@muiriswoulfe muiriswoulfe changed the title XS✔ ◾ [Autogenerated] Release v1.5.10 XS⚠️ ◾ [Autogenerated] Release v1.5.10 Jan 2, 2024
@microsoft microsoft deleted a comment from github-actions bot Jan 2, 2024
@microsoft microsoft deleted a comment from github-actions bot Jan 2, 2024
@microsoft microsoft deleted a comment from github-actions bot Jan 2, 2024
@microsoft microsoft deleted a comment from github-actions bot Jan 2, 2024
@microsoft microsoft deleted a comment from github-actions bot Jan 2, 2024
@muiriswoulfe muiriswoulfe enabled auto-merge (squash) January 2, 2024 17:56
@microsoft microsoft deleted a comment from github-actions bot Jan 2, 2024
@microsoft microsoft deleted a comment from github-actions bot Jan 2, 2024
@microsoft microsoft deleted a comment from github-actions bot Jan 3, 2024
@muiriswoulfe muiriswoulfe changed the title XS⚠️ ◾ [Autogenerated] Release v1.5.10 XS⚠️ ◾ Release v1.5.10 Jan 3, 2024
@microsoft microsoft deleted a comment from github-actions bot Jan 3, 2024
@microsoft microsoft deleted a comment from github-actions bot Jan 3, 2024
@github-actions github-actions bot changed the title XS⚠️ ◾ Release v1.5.10 XS✔ ◾ Release v1.5.10 Jan 5, 2024
@microsoft microsoft deleted a comment from github-actions bot Jan 5, 2024
@microsoft microsoft deleted a comment from github-actions bot Jan 5, 2024
@muiriswoulfe muiriswoulfe merged commit 31949f4 into main Jan 8, 2024
18 checks passed
@muiriswoulfe muiriswoulfe deleted the release/v1.5.10 branch January 8, 2024 10:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release Updates to enable a new release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants