OptimalControlProblems.jl/.github/workflows/UpdateReadme.yml at main · control-toolbox/OptimalControlProblems.jl · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
name: Update README with ABOUT.md and INSTALL.md

on:
  schedule:
    - cron: '0 6 * * 1'   # every Monday at 06:00 UTC
  workflow_dispatch:       # manual trigger

jobs:
  check-template:
    runs-on: ubuntu-latest
    outputs:
      has_template: ${{ steps.check.outputs.has_template }}
    steps:
      - name: Checkout repo
        uses: actions/checkout@v4

      - name: Check for README.template.md
        id: check
        shell: bash
        run: |
          if [[ -f "README.template.md" ]]; then
            echo "has_template=true" >> "$GITHUB_OUTPUT"
          else
            echo "has_template=false" >> "$GITHUB_OUTPUT"
            echo "README.template.md not found. Skipping README update." >&2
          fi

  call-shared:
    needs: check-template
    if: ${{ needs.check-template.outputs.has_template == 'true' }}
    uses: control-toolbox/CTActions/.github/workflows/update-readme.yml@main
    with:
      template_file: README.template.md
      output_file: README.md
      package_name: OptimalControlProblems        # package for INSTALL.md
      repo_name: control-toolbox/OptimalControlProblems.jl        # repository for CONTRIBUTING.md links
      doc_url: https://control-toolbox.org/OptimalControlProblems.jl
      citation_badge: "[![DOI](https://zenodo.org/badge/848989278.svg)](https://zenodo.org/doi/10.5281/zenodo.17013179)" # example, can be empty
      assignee: "ocots"
    secrets: inherit