From 66db8c2d7cbe5441596c2023bd047c3fd276b4de Mon Sep 17 00:00:00 2001 From: Jeff Napper <103025963+jnapper7@users.noreply.github.com> Date: Thu, 6 Feb 2025 15:57:13 +0100 Subject: [PATCH 1/4] chore: Updated to remove templating and localize repo information. --- .github/CODEOWNERS | 12 +- .github/ISSUE_TEMPLATE/bug_report.yml | 7 +- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- .github/pull_request_template.md | 29 +---- .github/settings.yml | 119 ------------------- .gitignore | 24 ++++ CODE_OF_CONDUCT.md | 2 +- CONTRIBUTING.md | 12 +- MAINTAINERS.md | 5 +- README.md | 132 ++++----------------- SECURITY.md | 12 +- 11 files changed, 72 insertions(+), 284 deletions(-) delete mode 100644 .github/settings.yml create mode 100644 .gitignore diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index e45219e..aeb8fdd 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,9 +1,3 @@ -#################################################### -# -# List of approvers for project -# -##################################################### -# # Learn about CODEOWNERS file format: # https://help.github.com/en/articles/about-code-owners # @@ -12,8 +6,4 @@ # the repository. Unless a later match takes precedence, # the following users/teams will be requested for # review when someone opens a pull request. -* @agntcy/ - -# Enforces admin protections for repo configuration via probot settings app. -# ref: https://github.com/probot/settings#security-implications -.github/settings.yml @agntcy/ +* @CostaRegi @jnapper7 diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index a06ee2f..e590ae8 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -30,10 +30,7 @@ body: If applicable, provide the version number or release tag where this issue was encountered options: - - v1.0.0 - - v1.0.1 - - v1.0.2 - - v1.0.3 + - v0.0.1 default: 0 validations: required: false @@ -55,7 +52,7 @@ body: label: Checklist description: By submitting this issue, you agree to the following options: - - label: I have read the [contributing guidelines](/agntcy/repo-template/blob/main/CONTRIBUTING.md) + - label: I have read the [contributing guidelines](/agntcy/iomapper-agnt/blob/main/CONTRIBUTING.md) required: true - label: I have verified this does not duplicate an existing issue required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index e1c9470..7eab09f 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -48,7 +48,7 @@ body: label: Checklist description: By submitting this request, you agree to the following options: - - label: I have read the [contributing guidelines](/agntcy/repo-template/blob/main/CONTRIBUTING.md) + - label: I have read the [contributing guidelines](/agntcy/iomapper-agnt/blob/main/CONTRIBUTING.md) required: true - label: | I have verified this does not duplicate an existing feature request diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 3392ce7..5caa1fd 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,28 +1 @@ -# Description - -Please provide a meaningful description of what this change will do, or is for. -Bonus points for including links to related issues, other PRs, or technical -references. - -Note that by _not_ including a description, you are asking reviewers to do extra -work to understand the context of this change, which may lead to your PR taking -much longer to review, or result in it not being reviewed at all. - -## Type of Change - -- [ ] Bugfix -- [ ] New Feature -- [ ] Breaking Change -- [ ] Refactor -- [ ] Documentation -- [ ] Other (please describe) - -## Checklist - -- [ ] I have read the [contributing guidelines](/agntcy/repo-template/blob/main/CONTRIBUTING.md) -- [ ] Existing issues have been referenced (where applicable) -- [ ] I have verified this change is not present in other open pull requests -- [ ] Functionality is documented -- [ ] All code style checks pass -- [ ] New code contribution is covered by automated tests -- [ ] All new and existing tests pass +Please provide a meaningful description of what this change will do, or is for. \ No newline at end of file diff --git a/.github/settings.yml b/.github/settings.yml deleted file mode 100644 index 69fdc66..0000000 --- a/.github/settings.yml +++ /dev/null @@ -1,119 +0,0 @@ ---- -# These settings are synced to GitHub by https://probot.github.io/apps/settings/ - -repository: - # See https://developer.github.com/v3/repos/#edit for all available settings. - - # The name of the repository. Changing this will rename the repository - name: repo-template - - # A short description of the repository that will show up on GitHub - description: Agntcy Project Repo Template - - # A URL with more information about the repository - homepage: https://www.example.com - - # A comma-separated list of topics to set on the repository - topics: github, probot - - # Either `true` to make the repository private, or `false` to make it public. - private: true - - # Either `true` to enable issues for this repository, `false` to disable them. - has_issues: true - - # Either `true` to enable projects for this repository, or `false` to disable them. - # If projects are disabled for the organization, passing `true` will cause an API error. - has_projects: true - - # Either `true` to enable the wiki for this repository, `false` to disable it. - has_wiki: false - - # Either `true` to enable downloads for this repository, `false` to disable them. - has_downloads: true - - # Updates the default branch for this repository. - default_branch: main - - # Either `true` to allow squash-merging pull requests, or `false` to prevent - # squash-merging. - allow_squash_merge: true - - # Either `true` to allow merging pull requests with a merge commit, or `false` - # to prevent merging pull requests with merge commits. - allow_merge_commit: true - - # Either `true` to allow rebase-merging pull requests, or `false` to prevent - # rebase-merging. - allow_rebase_merge: true - - # Either `true` to enable automatic deletion of branches on merge, or `false` to disable - delete_branch_on_merge: true - - # Either `true` to enable automated security fixes, or `false` to disable - # automated security fixes. - enable_automated_security_fixes: true - - # Either `true` to enable vulnerability alerts, or `false` to disable - # vulnerability alerts. - enable_vulnerability_alerts: true - -# TODO: Enable this section once GitHub teams have been created & granted access to this repository -# See https://developer.github.com/v3/teams/#add-or-update-team-repository for options -# teams: -# # The permission to grant the team. Can be one of: -# # * `pull` - can pull, but not push to or administer this repository. -# # * `push` - can pull and push, but not administer this repository. -# # * `admin` - can pull, push and administer this repository. -# # * `maintain` - Recommended for project managers who need to manage the -# # repository without access to sensitive or destructive actions. -# # * `triage` - Recommended for contributors who need to proactively manage -# # issues and pull requests without write access. -# - name: -# permission: admin -# - name: -# permission: maintain -# - name: -# permission: triage - -# TODO: Enable this section once repository has been created & no further modifications are needed -# branches: -# - name: main -# # https://developer.github.com/v3/repos/branches/#update-branch-protection -# # Branch Protection settings. Set to null to disable -# protection: -# # Required. Require at least one approving review on a pull request, -# # before merging. Set to null to disable. -# required_pull_request_reviews: -# # The number of approvals required. (1-6) -# required_approving_review_count: 1 -# # Dismiss approved reviews automatically when a new commit is pushed. -# dismiss_stale_reviews: true -# # Blocks merge until code owners have reviewed. -# require_code_owner_reviews: true -# # Specify which users and teams can dismiss pull request reviews. Pass -# # an empty dismissal_restrictions object to disable. User and team -# # dismissal_restrictions are only available for organization-owned -# # repositories. Omit this parameter for personal repositories. -# dismissal_restrictions: -# users: [] -# teams: [] -# # Required. Require status checks to pass before merging. Set to null to disable -# required_status_checks: -# # Required. Require branches to be up to date before merging. -# strict: true -# # Required. The list of required status checks in order to merge into this branch -# contexts: [] -# # Required. Enforce all configured restrictions for administrators. Set to -# # true to enforce required status checks for repository administrators. -# # Set to null to disable. -# enforce_admins: true -# # Prevent merge commits from being pushed to matching branches -# required_linear_history: true -# # Required. Restrict who can push to this branch. Team and user -# # restrictions are only available for organization-owned repositories. Set -# # to null to disable. -# restrictions: -# apps: [] -# users: [] -# teams: [] diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3c02882 --- /dev/null +++ b/.gitignore @@ -0,0 +1,24 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# Environments +.env* +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +.vscode/ +.idea/ + +# misc +.DS_Store diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 37a95ff..4d6ecad 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -60,7 +60,7 @@ representative at an online or offline event. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at -. All complaints will be reviewed and investigated +[moderation@agntcy.ai](mailto:moderation@agtncy.ai). All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 794ed8c..489a9de 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # How to Contribute -Thanks for your interest in contributing to ``! Here are a few +Thanks for your interest in contributing to IO-Mapper Agent project! Here are a few general guidelines on contributing and reporting bugs that we ask you to review. Following these guidelines helps to communicate that you respect the time of the contributors managing and developing this open source project. In return, they @@ -18,7 +18,7 @@ in any real-time space e.g., Slack, Discord, etc. Before reporting a new issue, please ensure that the issue was not already reported or fixed by searching through our [issues -list](https://github.com/org_name/repo_name/issues). +list](https://github.com/agntcy/iomapper-agnt/issues). When creating a new issue, please be sure to include a **title and clear description**, as much relevant information as possible, and, if possible, a @@ -39,7 +39,7 @@ major version release. ## Other Ways to Contribute -We welcome anyone that wants to contribute to `` to triage and +We welcome anyone that wants to contribute to this project to triage and reply to open issues to help troubleshoot and fix existing bugs. Here is what you can do: @@ -47,12 +47,12 @@ you can do: _[Reporting Issues](#reporting-issues)_ section, providing feedback to the issue's author on what might be missing. - Review and update the existing content of our - [Wiki](https://github.com/org_name/repo_name/wiki) with up-to-date + [Wiki](https://github.com/agntcy/iomapper-agnt/wiki) with up-to-date instructions and code samples. - Review existing pull requests, and testing patches against real existing - applications that use ``. + applications that use the project. - Write a test, or add a missing test case to an existing test. -Thanks again for your interest on contributing to ``! +Thanks again for your interest on contributing! :heart: diff --git a/MAINTAINERS.md b/MAINTAINERS.md index 422fdc0..f2555ca 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -1,5 +1,4 @@ # Maintainers -- [GitHub Username](https://github.com/username) -- [GitHub Username](https://github.com/username) -- [GitHub Username](https://github.com/username) +- [Jeff Napper](https://github.com/jnapper7) +- [Reginaldo Costa](https://github.com/CostaRegi) \ No newline at end of file diff --git a/README.md b/README.md index d4adeb7..16f8b7d 100644 --- a/README.md +++ b/README.md @@ -1,121 +1,48 @@ -# Agntcy Repo Project Template +# IO-Mapper Agent -[![Release](https://img.shields.io/github/v/release/agntcy/repo-template?display_name=tag)](CHANGELOG.md) -[![Lint](https://github.com/agntcy/repo-template/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/marketplace/actions/super-linter) +[![Release](https://img.shields.io/github/v/release/agntcy/iomapper-agnt?display_name=tag)](CHANGELOG.md) +[![Lint](https://github.com/agntcy/iomapper-agnt/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/marketplace/actions/super-linter) [![Contributor-Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-fbab2c.svg)](CODE_OF_CONDUCT.md) -## Before You Start - -As much as possible, we have tried to provide enough tooling to get you up and -running quickly and with a minimum of effort. This includes sane defaults for -documentation; templates for bug reports, feature requests, and pull requests; -and [GitHub Actions](https://github.com/features/actions) that will -automatically manage stale issues and pull requests. This latter defaults to -labeling issues and pull requests as stale after 60 days of inactivity, and -closing them after 7 additional days of inactivity. These -[defaults](.github/workflows/stale.yml) and more can be configured. For -configuration options, please consult the documentation for the [stale -action](https://github.com/actions/stale). - -In trying to keep this template as generic and reusable as possible, there are -some things that were omitted out of necessity and others that need a little -tweaking. Before you begin developing in earnest, there are a few changes that -need to be made: - -- [ ] ✅ Select an [OSI-approved license](https://opensource.org/licenses) for - your project. This can easily be achieved through the 'Add File' button on the - GitHub UI, naming the file `LICENSE`, and selecting your desired license from - the provided list. -- [ ] Update the `` placeholder in this file to reflect the name - of the license you selected above. -- [ ] Replace `` in - [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) with a suitable communication - channel. -- [ ] Change references to `org_name` to the name of the org your repository belongs - to (eg. `agntcy`): - - [ ] In [`README.md`](README.md) - - [ ] In [`CONTRIBUTING.md`](CONTRIBUTING.md) -- [ ] Change references to `repo_name` to the name of your new repository: - - [ ] In [`README.md`](README.md) - - [ ] In [`CONTRIBUTING.md`](CONTRIBUTING.md) -- [ ] Update the Release and Lint `README` badges to point to your project URL. -- [ ] Update the links to `CONTRIBUTING.md` to point to your project URL: - - [ ] In - [`.github/ISSUE_TEMPLATE/bug_report.yml`](.github/ISSUE_TEMPLATE/bug_report.yml) - - [ ] In - [`.github/ISSUE_TEMPLATE/feature_request.yml`](.github/ISSUE_TEMPLATE/feature_request.yml) - - [ ] In - [`.github/pull_request_template.md`](.github/pull_request_template.md) -- [ ] Update the `Affected Version` tags in - [`.github/ISSUE_TEMPLATE/bug_report.yml`](.github/ISSUE_TEMPLATE/bug_report.yml) - if applicable. -- [ ] Replace the `` placeholder with the name of your project: - - [ ] In [`CONTRIBUTING.md`](CONTRIBUTING.md) - - [ ] In [`SECURITY.md`](SECURITY.md) -- [ ] Add names and contact information for the project maintainers to - [`MAINTAINERS.md`](MAINTAINERS.md). -- [ ] Update the `` placeholder in - [`.github/CODEOWNERS`](.github/CODEOWNERS) as well as the - `` and `` entries. -- [ ] Delete the release placeholder content in [`CHANGELOG.md`](CHANGELOG.md). - We encourage you to [keep a changelog](https://keepachangelog.com/en/1.0.0/). -- [ ] Configure [`.github/dependabot.yml`](.github/dependabot.yml) for your project's - language and tooling dependencies. -- [ ] In [`.github/settings.yml`](.github/settings.yml), update the following fields: - - [ ] `name`: Replace with the repository name for your project - - [ ] `description`: A short, 1-2 sentence description of your project - - [ ] `teams`: Uncomment and update the GitHub team names and permissions as appropriate - - [ ] `branches`: Uncomment and enable branch protection settings for your - project _(please **do not** disable branch protection entirely!)_ -- [ ] Replace the generic content in this file with the relevant details about - your project. -- [ ] 🚨 Delete this section of the `README`! - ## About The Project -Provide some information about what the project is/does. +When connecting agents in an application, the output of one agent needs to be compatible with the input of the following agent. This compatibility needs to be guaranteed at three different levels: -## Getting Started + 1. transport level: the two agents need to use the same transport protocol. + 2. format level: the two agents need to carry information using the same format (e.g. same JSON data structures) + 3. semantic level: the two agents need to “talk about the same thing”. -To get a local copy up and running follow these simple steps. +Communication between agents is not possible if there are discrepancies between the agents at any of the layers [1-3]. -### Prerequisites +Ensuring that agents are semantically compatible, i.e., the output of the one agent contains the information needed by later agents, is an problem of composition or planning in the application. This project, the IO Mapper Agent, addresses level 2 and 3 compatibility. It is a component, implemented as an agent, that can make use of an LLM to transform the output of one agent to become compatible to the input of another agent. Note that this may mean many different things, for example: -This is an example of how to list things you need to use the software and how to -install them. + * JSON structure transcoding: A JSON dictionary needs to be remapped into another JSON dictionary + * Text summarisation: A text needs to be summarised or some information needs to be removed + * Text translation: A text needs to be translated from one language to another + * Text manipulation: Part of the information of one text needs to be reformulated into another text + * Any combination of the above -- npm +The IO mapper Agent can be fed the schema definitions of inputs and outputs as defined by the [Agent Connect Protocol](https://github.com/agntcy/acp-spec). - ```sh - npm install npm@latest -g - ``` +## Getting Started -### Installation +To get a local copy up and running follow these simple steps. -1. Clone the repository +### Prerequisites - ```sh - git clone https://github.com/org_name/repo_name.git - ``` +### Installation -2. Install npm packages +1. Clone the repository ```sh - npm install + git clone https://github.com/agntcy/iomapper-agnt.git ``` ## Usage -Use this space to show useful examples of how a project can be used. Additional -screenshots, code examples and demos work well in this space. You may also link -to more resources. - -_For more examples, please refer to the [Documentation](https://example.com) or -the [Wiki](https://github.com/org_name/repo_name/wiki)_ - ## Roadmap -See the [open issues](https://github.com/org_name/repo_name/issues) for a list +See the [open issues](https://github.com/agntcy/iomapper-agnt/issues) for a list of proposed features (and known issues). ## Contributing @@ -127,25 +54,18 @@ appreciated**. For detailed contributing guidelines, please see ### Top contributors - - contrib.rocks image + + contrib.rocks image

(back to top)

## License -Distributed under the `` License. See [LICENSE](LICENSE) for more +Distributed under the Apache-2.0 License. See [LICENSE](LICENSE) for more information. ## Contact -Your Name - [@github_handle](https://github.com/github_handle) - email - Project Link: -[https://github.com/org_name/repo_name](https://github.com/org_name/repo_name) - -## Acknowledgements - -This template was adapted from -[https://github.com/othneildrew/Best-README-Template](https://github.com/othneildrew/Best-README-Template). +[https://github.com/agntcy/iomapper-agnt](https://github.com/agntcy/iomapper-agnt) diff --git a/SECURITY.md b/SECURITY.md index b021bd2..04e0b74 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,7 +1,7 @@ # Security Policies and Procedures This document outlines security procedures and general policies for the -`` project. +project. - [Security Policies and Procedures](#security-policies-and-procedures) - [Disclosing a security issue](#disclosing-a-security-issue) @@ -10,12 +10,12 @@ This document outlines security procedures and general policies for the ## Disclosing a security issue -The `` maintainers take all security issues in the project -seriously. Thank you for improving the security of ``. We +The maintainers take all security issues in the project +seriously. Thank you for improving the security of this project. We appreciate your dedication to responsible disclosure and will make every effort to acknowledge your contributions. -`` leverages GitHub's private vulnerability reporting. +This project leverages GitHub's private vulnerability reporting. To learn more about this feature and how to submit a vulnerability report, review [GitHub's documentation on private reporting](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability). @@ -31,6 +31,10 @@ A maintainer will acknowledge the report within three (3) business days, and will send a more detailed response within an additional three (3) business days indicating the next steps in handling your report. +If you've been unable to successfully draft a vulnerability report via GitHub or +have not received a response during the alloted response window, please reach out via +[security@agntcy.ai](mailto:security@agntcy.ai) contact email. + After the initial reply to your report, the maintainers will endeavor to keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance. From 5b3818d10dae7628716d016a497e8e6c52d60cb4 Mon Sep 17 00:00:00 2001 From: Jeff Napper <103025963+jnapper7@users.noreply.github.com> Date: Thu, 6 Feb 2025 16:11:02 +0100 Subject: [PATCH 2/4] chore: fix markdown linting errors. --- MAINTAINERS.md | 2 +- README.md | 30 +++++++++++++++++------------- 2 files changed, 18 insertions(+), 14 deletions(-) diff --git a/MAINTAINERS.md b/MAINTAINERS.md index f2555ca..67c27c8 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -1,4 +1,4 @@ # Maintainers - [Jeff Napper](https://github.com/jnapper7) -- [Reginaldo Costa](https://github.com/CostaRegi) \ No newline at end of file +- [Reginaldo Costa](https://github.com/CostaRegi) diff --git a/README.md b/README.md index 16f8b7d..9644e19 100644 --- a/README.md +++ b/README.md @@ -8,19 +8,23 @@ When connecting agents in an application, the output of one agent needs to be compatible with the input of the following agent. This compatibility needs to be guaranteed at three different levels: - 1. transport level: the two agents need to use the same transport protocol. - 2. format level: the two agents need to carry information using the same format (e.g. same JSON data structures) - 3. semantic level: the two agents need to “talk about the same thing”. - -Communication between agents is not possible if there are discrepancies between the agents at any of the layers [1-3]. - -Ensuring that agents are semantically compatible, i.e., the output of the one agent contains the information needed by later agents, is an problem of composition or planning in the application. This project, the IO Mapper Agent, addresses level 2 and 3 compatibility. It is a component, implemented as an agent, that can make use of an LLM to transform the output of one agent to become compatible to the input of another agent. Note that this may mean many different things, for example: - - * JSON structure transcoding: A JSON dictionary needs to be remapped into another JSON dictionary - * Text summarisation: A text needs to be summarised or some information needs to be removed - * Text translation: A text needs to be translated from one language to another - * Text manipulation: Part of the information of one text needs to be reformulated into another text - * Any combination of the above +1. transport level: the two agents need to use the same transport protocol. +2. format level: the two agents need to carry information using the same format (e.g. same JSON data structures) +3. semantic level: the two agents need to “talk about the same thing”. + +Communication between agents is not possible if there are discrepancies between the agents at any of the layers [1-3]. + +Ensuring that agents are semantically compatible, i.e., the output of the one agent contains the information needed +by later agents, is an problem of composition or planning in the application. This project, the IO Mapper Agent, +addresses level 2 and 3 compatibility. It is a component, implemented as an agent, that can make use of an LLM +to transform the output of one agent to become compatible to the input of another agent. Note that this may mean +many different things, for example: + +* JSON structure transcoding: A JSON dictionary needs to be remapped into another JSON dictionary +* Text summarisation: A text needs to be summarised or some information needs to be removed +* Text translation: A text needs to be translated from one language to another +* Text manipulation: Part of the information of one text needs to be reformulated into another text +* Any combination of the above The IO mapper Agent can be fed the schema definitions of inputs and outputs as defined by the [Agent Connect Protocol](https://github.com/agntcy/acp-spec). From 2f16e25c92cd5f56ff07928dfdd4ffb94bda11f9 Mon Sep 17 00:00:00 2001 From: Jeff Napper <103025963+jnapper7@users.noreply.github.com> Date: Thu, 6 Feb 2025 16:17:05 +0100 Subject: [PATCH 3/4] chore: move to relaxed linting. --- .github/linters/.markdownlint.yml | 43 +------------------------------ .github/linters/.yamllint.yml | 6 ++--- 2 files changed, 3 insertions(+), 46 deletions(-) diff --git a/.github/linters/.markdownlint.yml b/.github/linters/.markdownlint.yml index ccac334..1f20366 100644 --- a/.github/linters/.markdownlint.yml +++ b/.github/linters/.markdownlint.yml @@ -1,43 +1,2 @@ --- -# Default state for all rules -default: true -# Path to configuration file to extend -extends: null - -# MD013/line-length -# https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md013.md -MD013: - # Number of characters - line_length: 150 - # Include code blocks - code_blocks: true - # Include tables - tables: true - # Include headings - headings: true - # Strict length checking - strict: false - # Stern length checking - stern: false - -# MD024/no-duplicate-heading -# https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md024.md -MD024: - # Only check sibling headings - siblings_only: true - -# MD025/single-title/single-h1 -# https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md025.md -MD025: - # RegExp for matching title in front matter - front_matter_title: "" - -# MD041/first-line-heading/first-line-h1 -# https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md041.md -MD041: - # RegExp for matching title in front matter - front_matter_title: "" - -# MD033/no-inline-html -MD033: - allowed_elements: ['a', 'img', 'alt', 'p'] +extends: relaxed diff --git a/.github/linters/.yamllint.yml b/.github/linters/.yamllint.yml index 0591216..6d39f3d 100644 --- a/.github/linters/.yamllint.yml +++ b/.github/linters/.yamllint.yml @@ -1,10 +1,8 @@ --- -extends: default +extends: relaxed rules: - line-length: - max: 120 - level: warning + line-length: disable comments: disable indentation: disable truthy: From 3e9943df348cb9f7a206d1386288462bfd3849ca Mon Sep 17 00:00:00 2001 From: Jeff Napper <103025963+jnapper7@users.noreply.github.com> Date: Thu, 6 Feb 2025 16:25:57 +0100 Subject: [PATCH 4/4] chore: remove linting actions. --- .github/linters/.markdownlint.yml | 2 -- .github/linters/.yamllint.yml | 9 ------- .github/workflows/lint.yml | 41 ------------------------------- 3 files changed, 52 deletions(-) delete mode 100644 .github/linters/.markdownlint.yml delete mode 100644 .github/linters/.yamllint.yml delete mode 100644 .github/workflows/lint.yml diff --git a/.github/linters/.markdownlint.yml b/.github/linters/.markdownlint.yml deleted file mode 100644 index 1f20366..0000000 --- a/.github/linters/.markdownlint.yml +++ /dev/null @@ -1,2 +0,0 @@ ---- -extends: relaxed diff --git a/.github/linters/.yamllint.yml b/.github/linters/.yamllint.yml deleted file mode 100644 index 6d39f3d..0000000 --- a/.github/linters/.yamllint.yml +++ /dev/null @@ -1,9 +0,0 @@ ---- -extends: relaxed - -rules: - line-length: disable - comments: disable - indentation: disable - truthy: - check-keys: false diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml deleted file mode 100644 index fc83082..0000000 --- a/.github/workflows/lint.yml +++ /dev/null @@ -1,41 +0,0 @@ ---- -name: lint - -on: - push: - # Run superlinter on pushes to default branch - branches: - - main - # Run superlinter on pull request events - pull_request: - -# Declare default permissions as read-only -permissions: read-all - -jobs: - super-linter: - runs-on: ubuntu-latest - permissions: - contents: read - packages: read - statuses: write - steps: - - name: 🔒 harden runner - uses: step-security/harden-runner@cb605e52c26070c328afc4562f0b4ada7618a84e # v2.10.4 - with: - egress-policy: audit - - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 - with: - fetch-depth: 0 - - name: 🧹 run superlinter - uses: super-linter/super-linter@85f7611e0f7b53c8573cca84aa0ed4344f6f6a4d # v7.2.1 - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - LINTER_RULES_PATH: ".github/linters" - MARKDOWN_CONFIG_FILE: ".markdownlint.yml" - YAML_CONFIG_FILE: ".yamllint.yml" - VALIDATE_ALL_CODEBASE: false - VALIDATE_MARKDOWN_PRETTIER: false - VALIDATE_YAML_PRETTIER: false - VALIDATE_NATURAL_LANGUAGE: false - MULTI_STATUS: false