Skip to content
This repository has been archived by the owner on Apr 22, 2023. It is now read-only.

doc REPLACEME linter/fixer #29

Closed
refack opened this issue Oct 3, 2018 · 3 comments
Closed

doc REPLACEME linter/fixer #29

refack opened this issue Oct 3, 2018 · 3 comments

Comments

@refack
Copy link

refack commented Oct 3, 2018

  - version: REPLACEME
    pr-url: REPLACEME

When originally authoring a PR that has API doc changes, you can't know the pr-url apriori. So this issue can't be trivially linted.
We should either:

  1. Lint only via ncu before landing
  2. Get Jenkins to suggest change (if PR ID is available)
  3. Fail lint so PRs don't get green CI until this is fixed
  4. Create a REPLACEME replace tool for releasers, that deduces the pr-url
@refack refack mentioned this issue Oct 3, 2018
4 tasks
@addaleax
Copy link
Member

addaleax commented Oct 3, 2018

I think anything except maybe 4. would be okay, and these suggestions don’t necessarily conflict with each other. 1. would be very good to have, in any case.

@BridgeAR
Copy link
Member

BridgeAR commented Oct 3, 2018

Hm, thinking about it: 4 would be the "easiest" one for authors. We have the information in the individual commit, it would just not be completely trivial to find the correct entry.

So to me all options sound good.

@Trott
Copy link
Member

Trott commented Apr 22, 2023

Unarchived this repo so I could close all the PRs and issues. Will re-archive when I'm done.

@Trott Trott closed this as completed Apr 22, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants