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

[pull] main from OAI:main #1

Open
wants to merge 229 commits into
base: main
Choose a base branch
from
Open

[pull] main from OAI:main #1

wants to merge 229 commits into from

Conversation

pull[bot]
Copy link

@pull pull bot commented May 8, 2024

See Commits and Changes for more details.


Created by pull[bot]

Can you help keep this open source service alive? 💖 Please sponsor : )

Summary by CodeRabbit

  • New Features

    • Introduced a new CONTRIBUTING.md file to guide users on contributing to the OpenAPI Specification.
    • Added a proposal for marking API elements as "experimental" to clarify features that are not yet stable.
    • Introduced a new proposal on "Self-Identification" to enhance resource identifier management within OpenAPI documents.
    • Added a new HTML document showcasing the OpenAPI Specification version 30.0.1, along with structured Markdown files for better user guidance.
  • Improvements

    • Enhanced Markdown file handling in the repository with updated .gitattributes.
    • Updated issue filing configuration to disallow blank issues and provide clearer contact links.
    • Revised the agenda template for meetings to assign responsibilities and add an "Active Projects" section.
    • Updated build and test scripts for improved functionality and coverage reporting.
  • Documentation

    • Expanded SECURITY_CONSIDERATIONS.md with new sections detailing security implications.
    • Condensed content in SPECIAL_INTEREST_GROUPS.md for clarity.
    • Added a README in the tests/md2html directory to guide users on viewing HTML files with Respec formatting.
    • Introduced a new EDITORS.md file listing active and emeritus editors for transparency.
  • Bug Fixes

    • Updated personal details in MAINTAINERS.md to reflect correct GitHub username.
  • Visual Enhancements

    • Updated CSS for syntax highlighting to improve readability and aesthetic appeal in code displays.

davidjgoss and others added 30 commits October 28, 2020 11:19
Bumps [vitest](https://github.com/vitest-dev/vitest/tree/HEAD/packages/vitest) from 1.4.0 to 1.5.0.
- [Release notes](https://github.com/vitest-dev/vitest/releases)
- [Commits](https://github.com/vitest-dev/vitest/commits/v1.5.0/packages/vitest)

---
updated-dependencies:
- dependency-name: vitest
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Ralf Handl <ralf.handl@sap.com>
Bumps [@hyperjump/json-schema](https://github.com/hyperjump-io/json-schema) from 1.7.3 to 1.8.0.
- [Commits](hyperjump-io/json-schema@v1.7.3...v1.8.0)

---
updated-dependencies:
- dependency-name: "@hyperjump/json-schema"
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
…son-schema-1.8.0

Bump @hyperjump/json-schema from 1.7.3 to 1.8.0
This parallels a change submitted by @i-ky on our learn repo,
as a way to attract the right participation.  Our repo currently
looks more like a JavaScript package, which may partially explain
several recent issues opened with the expectation that this is
a published JavaScript project. Our JavaScript is really just our
test environment for our Markdown.
We've started actually reaching the end of the meeting-specific
agenda, which is great.  We have tended to look at the open
projects, but that has required someone suggesting that action.

This adds a link to the open projects after the spec PRs and
before the new issues (which looks for unlabled issues).
We want to send people asking questions (as opposed to reporting
issues) or asking about tools or additional documentation to the
right places.  The previous links mostly sent people to other
docs rather than to places where they could get questions
answered or report other kinds of issues.
Co-authored-by: Ralf Handl <ralf.handl@sap.com>
Add open projects to the weekly TDC agenda
This adds links for things we actually want people to do in this
repository.  It directs enhancement requests to discussions rather
than issues, mirroring what we're doing for the sig-moonwalk repo.

This is done in the config file rather than with issue templates
because GitHub forces issue templates to display at the top of the
list, and the whole point of this configuration is to route people
to other repositories for certain things.
Bumps [vitest](https://github.com/vitest-dev/vitest/tree/HEAD/packages/vitest) from 1.5.0 to 1.5.1.
- [Release notes](https://github.com/vitest-dev/vitest/releases)
- [Commits](https://github.com/vitest-dev/vitest/commits/v1.5.1/packages/vitest)

---
updated-dependencies:
- dependency-name: vitest
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (4)
EDITORS.md (4)

3-3: Add a blank line after the heading.

To improve readability and adhere to markdown best practices, add a blank line after the "## Active" heading.

Apply this diff:

 ## Active
+
Tools
Markdownlint

3-3: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


14-14: Add a blank line after the heading.

To improve readability and adhere to markdown best practices, add a blank line after the "## Emeritus" heading.

Apply this diff:

 ## Emeritus
+
Tools
Markdownlint

14-14: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


4-4: Add a blank line before the list.

To improve readability and adhere to markdown best practices, add a blank line before the list under the "## Active" heading.

Apply this diff:

 ## Active
Tools
Markdownlint

4-4: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


15-15: Add a blank line before the list.

To improve readability and adhere to markdown best practices, add a blank line before the list under the "## Emeritus" heading.

Apply this diff:

 ## Emeritus
Tools
Markdownlint

15-15: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 097ee45 and f8114db.

Files selected for processing (3)
  • EDITORS.md (1 hunks)
  • MAINTAINERS.md (2 hunks)
  • scripts/md2html/build.sh (2 hunks)
Files skipped from review due to trivial changes (1)
  • MAINTAINERS.md
Files skipped from review as they are similar to previous changes (1)
  • scripts/md2html/build.sh
Additional context used
Markdownlint
EDITORS.md

3-3: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


14-14: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


4-4: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


15-15: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

build script: example links point to HTML wrapper on learn site
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f8114db and c754de0.

Files selected for processing (6)
  • package.json (2 hunks)
  • scripts/md2html/md2html.js (6 hunks)
  • tests/md2html/fixtures/basic-new.html (1 hunks)
  • tests/md2html/fixtures/basic-old.html (1 hunks)
  • tests/md2html/fixtures/basic-old.md (1 hunks)
  • vitest.config.js (1 hunks)
Files skipped from review as they are similar to previous changes (3)
  • package.json
  • tests/md2html/fixtures/basic-new.html
  • tests/md2html/fixtures/basic-old.html
Additional context used
Markdownlint
tests/md2html/fixtures/basic-old.md

5-5: Expected: h2; Actual: h4
Heading levels should only increment by one level at a time

(MD001, heading-increment)

Additional comments not posted (9)
vitest.config.js (1)

1-7: Configuration looks good!

The Vitest configuration is correctly set up with forceRerunTriggers to rerun tests when files in the specified directories change.

tests/md2html/fixtures/basic-old.md (1)

5-5: Fix heading level increment.

The heading level should increment by one level at a time. Change #### to ## for consistency.

Tools
Markdownlint

5-5: Expected: h2; Actual: h4
Heading levels should only increment by one level at a time

(MD001, heading-increment)

scripts/md2html/md2html.js (7)

22-22: Update command-line argument handling.

The change from .require(1) to .demandCommand(1) clarifies the intent of enforcing the presence of a command.


34-35: Enhance accessibility in syntax highlighting.

Adding tabindex="0" to <pre> tags improves accessibility by allowing keyboard navigation.


46-84: Expand respec object with new properties.

The addition of latestVersion, logos, and otherLinks enhances the metadata and accessibility of the specification document.


207-209: Replace deprecated HTML tags.

The replacement of <a name="..."/> with <span id="..."></span> is a modern and semantically appropriate update.


229-232: Harmonize RFC URLs.

The changes ensure that all RFC URLs use HTTPS and point to the correct resources.


Line range hint 289-307: Fix heading indentation logic.

The logic ensures that each heading is at most one level deeper than the previous heading, improving document structure.


319-357: Wrap section text in <section> tags.

This change improves the document structure for tools like ReSpec, ensuring proper sectioning.

dependabot bot and others added 2 commits August 26, 2024 08:03
Bumps [@hyperjump/json-schema](https://github.com/hyperjump-io/json-schema) from 1.9.6 to 1.9.8.
- [Commits](hyperjump-io/json-schema@v1.9.6...v1.9.8)

---
updated-dependencies:
- dependency-name: "@hyperjump/json-schema"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
…son-schema-1.9.8

Bump @hyperjump/json-schema from 1.9.6 to 1.9.8
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c754de0 and 4e9d2b3.

Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
Files selected for processing (1)
  • package.json (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • package.json

lornajane and others added 24 commits September 1, 2024 18:05
Bumps [yaml](https://github.com/eemeli/yaml) from 2.5.0 to 2.5.1.
- [Release notes](https://github.com/eemeli/yaml/releases)
- [Commits](eemeli/yaml@v2.5.0...v2.5.1)

---
updated-dependencies:
- dependency-name: yaml
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Ralf Handl <ralf.handl@sap.com>
Bumps [respec](https://github.com/speced/respec) from 35.1.1 to 35.1.2.
- [Release notes](https://github.com/speced/respec/releases)
- [Changelog](https://github.com/speced/respec/blob/main/CHANGELOG.md)
- [Commits](speced/respec@v35.1.1...v35.1.2)

---
updated-dependencies:
- dependency-name: respec
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
[PROPOSAL] Add summary, parent and kind as optional fields for tags
Bumps [vitest](https://github.com/vitest-dev/vitest/tree/HEAD/packages/vitest) from 2.0.5 to 2.1.0.
- [Release notes](https://github.com/vitest-dev/vitest/releases)
- [Commits](https://github.com/vitest-dev/vitest/commits/v2.1.0/packages/vitest)

---
updated-dependencies:
- dependency-name: vitest
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Bumps [vitest](https://github.com/vitest-dev/vitest/tree/HEAD/packages/vitest) from 2.1.0 to 2.1.1.
- [Release notes](https://github.com/vitest-dev/vitest/releases)
- [Commits](https://github.com/vitest-dev/vitest/commits/v2.1.1/packages/vitest)

---
updated-dependencies:
- dependency-name: vitest
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Jay, I had a test for this 😄
Bumps [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) from 0.41.0 to 0.42.0.
- [Release notes](https://github.com/igorshubovych/markdownlint-cli/releases)
- [Commits](igorshubovych/markdownlint-cli@v0.41.0...v0.42.0)

---
updated-dependencies:
- dependency-name: markdownlint-cli
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
…t-cli-0.42.0

Bump markdownlint-cli from 0.41.0 to 0.42.0
Following the provisional period, welcome to the new maintainers! Thank you for all the work you've put in until now and for the progress yet to come. 🙏
Add in new full-TSC members
…hlighting

ReSpec build script: no automatic syntax highlighting for unspecified or "unknown" languages
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.