microsoft / code-with-engineering-playbook

This is the playbook for "code-with" customer or partner engagements
https://microsoft.github.io/code-with-engineering-playbook/
Creative Commons Attribution 4.0 International
2.15k stars 568 forks source link

add hint on ADR IDs #1027

Closed benjguin closed 3 months ago

benjguin commented 4 months ago

Pull Request Template

What are you trying to address

Description of new changes

Checklist

benjguin commented 4 months ago

@tompaana @TessFerrandez thanks a lot for the review. All looks good but a permission issue for MegaLinter

❌ Linted [MDLINKCHECK] files with [linkcheck]: Found 1 error(s) - (9.61s) (expand for details)
  --Error detail:
  time="2024-02-20T16:47:59Z" level=info msg="Starting linkcheck"
  time="2024-02-20T16:47:59Z" level=info msg="Context first argument .github/ISSUE_TEMPLATE/bug_report.md"
  time="2024-02-20T16:47:59Z" level=info msg="extracting markdown files from list"
  time="2024-02-20T16:47:59Z" level=info msg="Starting to process links"
  time="2024-02-20T16:47:59Z" level=info msg="Loading cache data from /github/workspace/megalinter-reports/linchcheck-cache"
  time="2024-02-20T16:47:59Z" level=error msg="File /github/workspace/megalinter-reports/linchcheck-cache does not exist, skipping cache loadstat /github/workspace/megalinter-reports/linchcheck-cache: no such file or directory"
  time="2024-02-20T16:48:09Z" level=info msg="Went through 257 files"
  time="2024-02-20T16:48:09Z" level=info msg="****************************"
  time="2024-02-20T16:48:09Z" level=info msg="Results for file /github/workspace/docs/documentation/recipes/deploy-docfx-azure-website.md"
  time="2024-02-20T16:48:09Z" level=info
  time="2024-02-20T16:48:09Z" level=info msg="Line 58 link https://stackoverflow.com/questions/[64](https://github.com/microsoft/code-with-engineering-playbook/actions/runs/7976990382/job/21778826318?pr=1027#step:4:65)309200/is-the-custom-domain-verification-shared-across-an-azure-subscription status 403"
  time="2024-02-20T16:48:09Z" level=info
  time="2024-02-20T16:48:09Z" level=info msg="Saving cache to path /github/workspace/megalinter-reports"
  time="2024-02-20T16:48:09Z" level=fatal msg="ERROR: 1 links check failed, please check the logs"

  [GitHub Status Reporter] Error posting Status for MDLINKCHECKwith linkcheck: 403
  GitHub API response: {"message":"Resource not accessible by integration","documentation_url":"https://docs.github.com/rest/commits/statuses#create-a-commit-status"}
  [GitHub Status Reporter] Error posting Status for SPELLwith cspell: 403
  GitHub API response: {"message":"Resource not accessible by integration","documentation_url":"https://docs.github.com/rest/commits/statuses#create-a-commit-status"}
  [flavors] You could have same capabilities but better runtime performances if you request a new MegaLinter flavor.
  [flavors] Use the following link to request the new flavor: https://github.com/oxsecurity/megalinter/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=Request%20new%20MegaLinter%20flavor&body=MegaLinter%20would%20run%20faster%20on%20my%20project%20if%20I%20had%20a%20flavor%20containing%20the%20following%20list%20of%20linters%3A%0A%0AACTION_ACTIONLINT%2C%20MARKDOWN_MARKDOWNLINT%2C%20MARKDOWN_MARKDOWN_TABLE_FORMATTER%2C%20MDLINKCHECK_LINKCHECK%2C%20SPELL_CSPELL%2C%20YAML_PRETTIER%2C%20YAML_YAMLLINT%0A%0AWould%20it%20be%20possible%20to%20create%20one%20%3F%20Thanks%20%3Arelaxed%3A
  [GitHub Comment Reporter] Unable to post pull request comment: 403 {"message": "Resource not accessible by integration", "documentation_url": "https://docs.github.com/rest/issues/comments#create-an-issue-comment"}.
  To enable this function, please add permissions in your Github Actions Workflow:
  permissions:
    issues: write
    pull-requests: write
  ❌ Error(s) have been found during linting
  To disable linters or customize their checks, you can use a .mega-linter.yml file at the root of your repository
  More info at https://megalinter.io/7.1.0/configuration/

I'm not sure I can do anything about it.