{"id":13311818,"url":"https://github.com/mnot/ietf-comments","last_synced_at":"2025-10-04T07:53:14.520Z","repository":{"id":39601259,"uuid":"466680667","full_name":"mnot/ietf-comments","owner":"mnot","description":"Automating IETF comment handling","archived":false,"fork":false,"pushed_at":"2025-02-04T00:03:48.000Z","size":157756,"stargazers_count":4,"open_issues_count":5,"forks_count":4,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-09-22T17:24:56.219Z","etag":null,"topics":["github","ietf","markdown","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mnot.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-03-06T08:37:17.000Z","updated_at":"2025-02-04T00:03:52.000Z","dependencies_parsed_at":"2024-10-27T17:18:56.723Z","dependency_job_id":"dbdb2667-d156-4ab3-9d04-e8a64e342aca","html_url":"https://github.com/mnot/ietf-comments","commit_stats":{"total_commits":108,"total_committers":3,"mean_commits":36.0,"dds":0.02777777777777779,"last_synced_commit":"bdf3fe1f0cdfbb81ebf06c4d87526a41febc252b"},"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"purl":"pkg:github/mnot/ietf-comments","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mnot%2Fietf-comments","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mnot%2Fietf-comments/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mnot%2Fietf-comments/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mnot%2Fietf-comments/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mnot","download_url":"https://codeload.github.com/mnot/ietf-comments/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mnot%2Fietf-comments/sbom","scorecard":{"id":655036,"data":{"date":"2025-08-11","repo":{"name":"github.com/mnot/ietf-comments","commit":"ef89602ebb503352875284ae5bc85ceef68f6939"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.9,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/26 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/mnot/ietf-comments/codeql-analysis.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/mnot/ietf-comments/codeql-analysis.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/mnot/ietf-comments/codeql-analysis.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/mnot/ietf-comments/codeql-analysis.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/mnot/ietf-comments/publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/mnot/ietf-comments/publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/mnot/ietf-comments/publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/mnot/ietf-comments/publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/mnot/ietf-comments/publish.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:63: update your workflow using https://app.stepsecurity.io/secureworkflow/mnot/ietf-comments/publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:92: update your workflow using https://app.stepsecurity.io/secureworkflow/mnot/ietf-comments/publish.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:97: update your workflow using https://app.stepsecurity.io/secureworkflow/mnot/ietf-comments/publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/mnot/ietf-comments/test.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/mnot/ietf-comments/test.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/mnot/ietf-comments/test.yml/main?enable=pin","Info:   0 out of  13 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql-analysis.yml:23","Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql-analysis.yml:24","Warn: jobLevel 'contents' permission set to 'write': .github/workflows/publish.yml:32","Warn: jobLevel 'contents' permission set to 'write': .github/workflows/publish.yml:53","Warn: no topLevel permission defined: .github/workflows/codeql-analysis.yml:1","Warn: no topLevel permission defined: .github/workflows/publish.yml:1","Warn: no topLevel permission defined: .github/workflows/test.yml:1"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: BSD 2-Clause \"Simplified\" License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":7,"reason":"SAST tool detected but not run on all commits","details":["Info: SAST configuration detected: CodeQL","Warn: 0 commits out of 4 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-21T14:25:39.283Z","repository_id":39601259,"created_at":"2025-08-21T14:25:39.283Z","updated_at":"2025-08-21T14:25:39.283Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278283455,"owners_count":25961311,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-04T02:00:05.491Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github","ietf","markdown","python"],"created_at":"2024-07-29T18:02:30.120Z","updated_at":"2025-10-04T07:53:14.470Z","avatar_url":"https://github.com/mnot.png","language":"Python","readme":"\n# The IETF Comments Processor\n\nHandling comments from the IESG, multiple directorate reviews, and in AUTH48 can be burdensome for document authors, because of the sheer number of comments, and because they come in an unstructured format that has to be manually processed.\n\nThis package installs two commands:\n\n* `ietf-comments` processes comments from the IESG and directorates in a [markdown](https://commonmark.org)-based format.\n* `rfced-comments` processes comments from the RFC Editor in RFC XML files.\n\nBoth can be used to create GitHub issues for the comments they find. When used properly, they can help automate formerly tiresome tasks.\n\nFor IESG and directorate comments, this tool uses the [IETF Comment Markdown format](https://github.com/mnot/ietf-comments/tree/main/format.md), which is a semi-structured format that is similar to that which ADs and directorates use now. Ideally, they will create comments in that format for easy processing, but even when they don't, most comments can easily be transformed into it for processing.\n\n\n## Online Validator\n\nIf you just need to validate markdown comments, see the [online comments validator](https://mnot.github.io/ietf-comments/).\n\n\n## Installation\n\nTo install ietf-comments, you'll need [Python](https://www.python.org/).\n\nThe best way to install it is using [pipx](https://pypa.github.io/pipx/), because that will automatically create an isolated environment for the dependencies:\n\n\u003e pipx install ietf-comments\n\n**Note** that to use rfced-comments, you'll need Python 3.10 or greater. To assure that Python 3.10 is being used, you may need to use something like:\n\n\u003e pipx install ietf-comments --python /path/to/python3.10\n\n\n## Use\n\n### Processing AD and Directorate Comments\n\nTo validate a AD or Directorate review in the [IETF Comment Markdown format](https://github.com/mnot/ietf-comments/tree/main/format.md) and see the identified issues, run:\n\n\u003e ietf-comments _filename_\n\nTo create a GitHub issue for each issue, set `GITHUB_ACCESS_TOKEN` in your environment to a [GitHub Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) and run:\n\n\u003e ietf-comments -g _owner/repo_ _filename_\n\n... where `owner/repo` is the repo owner and name, separated by a slash.\n\nIf you'd like these issues to have a specific label, run:\n\n\u003e ietf-comments -g _owner/repo_ _filename_ -l _labelname_\n\nIf you'd like `discuss`, `comment`, and `nit labels` added as appropriate, along with a `review` label, pass `-a`:\n\n\u003e ietf-comments -g _owner/repo_ _filename_ -a\n\n\n\n### Processing RFC Editor Comments\n\nTo validate RFC Editor comments in a local RFC XML file and see the identified issues, run:\n\n\u003e rfced-comments _filename_\n\nAlternatively, if you're in AUTH48 and the RFC Editor has published a draft of your RFC-to-be, you can just run\n\n\u003e rfced-comments _NNNN_\n\nwhere `NNNN` is the RFC number.\n\nTo create a GitHub issue for each issue, set `GITHUB_ACCESS_TOKEN` in your environment to a [GitHub Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) and run:\n\n\u003e rfced-comments -g _owner/repo_ _NNNN_or_filename_\n\n... where `owner/repo` is the repo owner and name, separated by a slash.\n\nIf you'd like these issues to have a specific label, run:\n\n\u003e rfced-comments -g _owner/repo_ _NNNN_or_filename_ -l _labelname_\n\n\n\n\n## Special Features\n\nThe following features are currently supported (more soon!):\n\n* When recognised, internal section references (e.g., `Section 2.4`) are auto-linked in created issues.\n* Likewise, references to external RFCs (e.g., `Section 5.3 of [RFC1234]`) will also be auto-linked in created issues when recognised.\n* Text in blockquotes (preceded by `\u003e`) in comments will be checked for presence in the document; if they aren't found, a warning will be raised.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmnot%2Fietf-comments","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmnot%2Fietf-comments","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmnot%2Fietf-comments/lists"}