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

DF-19335 add known issues section to readme generator #3090

Merged
merged 3 commits into from
Nov 15, 2023

Conversation

mmcallister-cll
Copy link
Contributor

@mmcallister-cll mmcallister-cll commented Nov 14, 2023

Closes #DF-19335

Description

Adds known issues section to readme generator based on presence of <ea>/docs/known-issues.md file.
Adds known issues section to readme for tp and icap adapters.

Changes

  • Update readme generator.ts with known issues section
  • add ability to read .md files
  • specific known issues files for tp and icap adapters

Steps to Test

  1. generate readme without known issues to test regression
  2. add file under a given adapter
  3. Verify presence of known issues section

Quality Assurance

  • If a new adapter was made, or an existing one was modified so that its environment variables have changed, update the relevant infra-k8s configuration file.
  • If a new adapter was made, or an existing one was modified so that its environment variables have changed, update the relevant adapter-secrets configuration file or update the soak testing blacklist.
  • If a new adapter was made, or a new endpoint was added, update the test-payload.json file with relevant requests.
  • The branch naming follows git flow (feature/x, chore/x, release/x, hotfix/x, fix/x) or is created from Jira.
  • This is related to a maximum of one Jira story or GitHub issue.
  • Types are safe (avoid TypeScript/TSLint features like any and disable, instead use more specific types).
  • All code changes have 100% unit and integration test coverage. If testing is not applicable or too difficult to justify doing, the reasoning should be documented explicitly in the PR.

@mmcallister-cll mmcallister-cll requested review from austinborn and a team November 14, 2023 22:26
Copy link

changeset-bot bot commented Nov 14, 2023

🦋 Changeset detected

Latest commit: 48ee53e

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages
Name Type
@chainlink/icap-adapter Patch
@chainlink/tp-adapter Patch
@chainlink/ea-scripts Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Contributor

@austinborn austinborn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changeset for TP and ICAP? I know it's not a functional change but if it's part of the package IMO it's worth versioning.

@mmcallister-cll mmcallister-cll merged commit a1c6726 into main Nov 15, 2023
8 checks passed
@mmcallister-cll mmcallister-cll deleted the feat/DF-19335-readme-known-issues branch November 15, 2023 01:49
@github-actions github-actions bot mentioned this pull request Nov 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants