curl/.github/workflows/linkcheck.yml

# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
#
# SPDX-License-Identifier: curl

name: Markdown links

on:
  push:
    branches:
      - master
      - '*/ci'
    paths:
      - '.github/workflows/linkcheck.yml'
      - '**.md'
  pull_request:
    branches:
      - master
    paths:
      - '.github/workflows/linkcheck.yml'
      - '**.md'

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
  cancel-in-progress: true

permissions: {}

jobs:
  # Docs: https://github.com/marketplace/actions/markdown-link-check
  check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        name: checkout

      - name: trim the cmdline docs markdown files
        run: find docs/cmdline-opts -name "*.md" ! -name "_*" ! -name MANPAGE.md | xargs -n1 ./.github/scripts/cleancmd.pl

      - uses: gaurav-nelson/github-action-markdown-link-check@v1
        with:
          use-quiet-mode: 'yes'
copyright: update all copyright lines and remove year ranges - they are mostly pointless in all major jurisdictions - many big corporations and projects already don't use them - saves us from pointless churn - git keeps history for us - the year range is kept in COPYING checksrc is updated to allow non-year using copyright statements Closes #10205 2023-01-02 20:51:48 +08:00			`# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.`
copyright: make repository REUSE compliant Add licensing and copyright information for all files in this repository. This either happens in the file itself as a comment header or in the file `.reuse/dep5`. This commit also adds a Github workflow to check pull requests and adapts copyright.pl to the changes. Closes #8869 2022-05-17 17:16:50 +08:00			`#`
			`# SPDX-License-Identifier: curl`

linkcheck.yml: add CI job that checks markdown links Closes #8158 2021-12-17 06:30:43 +08:00			`name: Markdown links`

			`on:`
			`push:`
			`branches:`
tidy-up: fix yamllint whitespace issues Closes #12466 2023-12-06 18:05:20 +08:00			`- master`
			`- '*/ci'`
CI/linkcheck: only run if a Markdown file is changed This saves CI resources and therefore a little energy. Reviewed-by: Max Dymond Closes #9531 2022-09-18 03:58:58 +08:00			`paths:`
tidy-up: fix yamllint whitespace issues Closes #12466 2023-12-06 18:05:20 +08:00			`- '.github/workflows/linkcheck.yml'`
			`- '**.md'`
linkcheck.yml: add CI job that checks markdown links Closes #8158 2021-12-17 06:30:43 +08:00			`pull_request:`
			`branches:`
tidy-up: fix yamllint whitespace issues Closes #12466 2023-12-06 18:05:20 +08:00			`- master`
CI/linkcheck: only run if a Markdown file is changed This saves CI resources and therefore a little energy. Reviewed-by: Max Dymond Closes #9531 2022-09-18 03:58:58 +08:00			`paths:`
tidy-up: fix yamllint whitespace issues Closes #12466 2023-12-06 18:05:20 +08:00			`- '.github/workflows/linkcheck.yml'`
			`- '**.md'`
linkcheck.yml: add CI job that checks markdown links Closes #8158 2021-12-17 06:30:43 +08:00
CI/GHA: cancel outdated CI runs on new PR changes Avoid letting outdated CI runs continue if a PR receives new changes. Outside a PR we let them continue running by tying the concurrency to the commit hash instead. Also only let one CodeQL or Hacktoberfest job run at a time. Other CI platforms we use have this build in, but GitHub unfortunately neither by default nor with a simple option. This saves CI resources and therefore a little energy. Approved-by: Daniel Stenberg Approved-by: Max Dymond Closes #9533 2022-09-18 05:45:32 +08:00			`concurrency:`
			`group: ${{ github.workflow }}-${{ github.event.pull_request.number \|\| github.sha }}`
			`cancel-in-progress: true`

GHA: clarify workflows permissions, set least possible privilege Set top-level permissions to None on all workflows, setting per-job permissions. This avoids that new jobs inherit unwanted permissions. Discussion: https://curl.se/mail/lib-2022-11/0028.html Signed-off-by: Diogo Teles Sant'Anna <diogoteles@google.com> Closes #9928 2022-11-16 22:55:33 +08:00			`permissions: {}`

linkcheck.yml: add CI job that checks markdown links Closes #8158 2021-12-17 06:30:43 +08:00			`jobs:`
GHA: align all install, configure and build steps again First step towards more unified build steps on GitHub Actions. Closes #8873 2022-05-18 06:03:16 +08:00			`# Docs: https://github.com/marketplace/actions/markdown-link-check`
linkcheck.yml: add CI job that checks markdown links Closes #8158 2021-12-17 06:30:43 +08:00			`check:`
			`runs-on: ubuntu-latest`
			`steps:`
tidy-up: fix yamllint whitespace issues Closes #12466 2023-12-06 18:05:20 +08:00			`- uses: actions/checkout@v4`
docs/cmdline: change to .md for cmdline docs - switch all invidual files documenting command line options into .md, as the documentation is now markdown-looking. - made the parser treat 4-space indents as quotes - switch to building the curl.1 manpage using the "mainpage.idx" file, which lists the files to include to generate it, instead of using the previous page-footer/headers. Also, those files are now also .md ones, using the same format. I gave them underscore prefixes to make them sort separately: _NAME.md, _SYNOPSIS.md, _DESCRIPTION.md, _URL.md, _GLOBBING.md, _VARIABLES.md, _OUTPUT.md, _PROTOCOLS.md, _PROGRESS.md, _VERSION.md, _OPTIONS.md, _FILES.md, _ENVIRONMENT.md, _PROXYPREFIX.md, _EXITCODES.md, _BUGS.md, _AUTHORS.md, _WWW.md, _SEEALSO.md - updated test cases accordingly Closes #12751 2024-01-21 06:18:43 +08:00			`name: checkout`

			`- name: trim the cmdline docs markdown files`
			`run: find docs/cmdline-opts -name ".md" ! -name "_" ! -name MANPAGE.md \| xargs -n1 ./.github/scripts/cleancmd.pl`

tidy-up: fix yamllint whitespace issues Closes #12466 2023-12-06 18:05:20 +08:00			`- uses: gaurav-nelson/github-action-markdown-link-check@v1`
			`with:`
			`use-quiet-mode: 'yes'`