Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Provide a Gradle plugin that applies REST Docs' configuration conventions

Aperta
#625 1 commento 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
30/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Ambito
build-system

Direzione di ricerca

Start by reviewing the existing Gradle configuration for snippetsDir, the test task, and Asciidoctor. Determine how the spring-restdocs-asciidoctor extension, snippet input/output directories, and task dependency should be represented in a plugin. Done means the REST Docs conventions can be applied automatically without repeating the listed configuration.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

type: enhancement

When you use REST Docs with Gradle there are a few things that need to be configured:

  1. snippetsDir extra property
  2. Additional output directory on the test task that points to the snippets directory

When you're also using Asciidoctor the following also needs to be configured:

  1. spring-restdocs-asciidoctor extension
  2. Additional input directory on the asciidoctor task that points to the snippets directory
  3. A dependency on the test task from the asciidoctor task

This configuration could be encapsulated in a plugin that applies these conventions, or a variant of them, automatically.

Lingua principale
Java
Stelle
1.2k
Fork
733
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di spring-projects/spring-restdocs

Tutte le issue di spring-projects/spring-restdocs

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.