JabRef / JabRef/user-documentation

Add action to automatically sync check_links.yml workflow with main Jabref/jabref repo

Open
#534 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
54
Forks
142
Avg merge
23h 56m
Merged PRs (30d)
12

Description

As suggested here https://github.com/JabRef/user-documentation/pull/526#issuecomment-2416490491.

See partial work here: https://github.com/JabRef/user-documentation/pull/531#issuecomment-2418791254

Personally don't have the Github workflow knowledge to pull this off in a timely manner

Though should also discuss: if #533 is resolved then the .lycheeignore will be drastically improved on this repo compared to on JabRef. It might actually make more sense to sync the other way, i.e. copy check_links.yml and .lycheeignore over from this repo to main JabRef? This repo contains more documentation and links to check/ignore after all.

Or perhaps abandon syncing completely if the different repos have different link checking needs? (in which case we can close this issue)

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

Read the partial work in pull request #531 and compare check_links.yml and .lycheeignore in this repository with the main JabRef/jabref repository. First resolve whether synchronization should copy files in either direction or be abandoned, then define the workflow behavior and verify that the selected files stay synchronized.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.