json-schema-org / json-schema-org/JSON-Schema-Test-Suite

Document how to use Dependabot to keep a test suite submodule up to date

Open
#549 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
750
Forks
307
Avg merge
3d 17h
Merged PRs (30d)
24

Description

(Via @Relequestual here)

Implementers may appreciate a GitHub action which automatically sends PRs to their repo to update the test suite.

As a concrete example, python-jsonschema has a git-subtree of this suite here, and would benefit from automated pull requests whenever the main branch of this repository is updated.

To do this in general, such a github action would need to be configured with the path within a repo where the subtree lives, likely need to support both git-subtree as well as git-submodule (and possibly git-subrepo), and allow for passing options to the subtree/submodule command (e.g. if someone wanted a git subtree pull --squash to be the PR).

It's unclear that this should live in this precise repo rather than an adjacent one, but putting it here to track/ack the request.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the referenced python-jsonschema git-subtree example and the request's Dependabot context first. Clarify whether the guidance belongs in this repository or an adjacent one, then define the expected documentation for git-subtree and git-submodule updates, repository-path configuration, and command options; completion requires an agreed scope and usable instructions.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, github-actions
Domain
ci-cd, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.