automatic-copyright-year: keep README copyright current

Offen
#189 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

@anshulchikhale30-p arbeitet bereits daran.

Seit 15.11.2026.

  • #190 von @anshulchikhale30-p — offen

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
Ein halber Tag
Anfängerfreundlichkeit
35/100
Issue-Typ
Feature
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
github-actions, python
Bereich
ci-cd, documentation

Rechercherichtung

Start by reading pull request #190, which is already open against this issue, and the footer line in README.md. Then look at the existing workflows under .github/workflows/ to match conventions, and write a scheduled plus workflow_dispatch job with contents: write that rewrites only the copyright line and checks git diff before committing. Done means a manual run on 2026 produces © 2025-2026 The Stable Order., a second run makes no commit, and the chosen push-vs-PR path is settled against branch protection.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

documentation enhancement

Summary

The README footer hardcodes the copyright year:

© 2025 The Stable Order.

It should automatically show the current year range. For 2026:

© 2025-2026 The Stable Order.

and on January 1, 2027 it should become:

© 2025-2027 The Stable Order.

without a manual edit.

Proposed behavior

  • Start year stays 2025.
  • End year is the current UTC year.
  • If the current year is 2025, render © 2025 The Stable Order.
  • If the current year is later, render © 2025-<current-year> The Stable Order.
  • The update must be idempotent: if the line already matches, make no commit.

Suggested implementation

Add a small scheduled GitHub Actions workflow, for example:

  • on.schedule with a January 1 cron, plus workflow_dispatch for testing.
  • permissions: contents: write.
  • A short Python or shell step that updates only the copyright line in README.md.
  • Commit only when the value changed.

If main is protected, the workflow can open a PR instead of pushing directly. That can be decided during implementation.

Scope

  • Only the README copyright line.
  • No license text changes.
  • No unrelated README edits.
  • No PR yet; this issue is for discussion and approval first.

Acceptance criteria

  • README shows © 2025-2026 The Stable Order. for 2026.
  • On January 1, 2027 it updates to © 2025-2027 The Stable Order. automatically.
  • Re-running the workflow in the same year makes no change and no empty commit.
  • The workflow can be run manually for testing.
  • Only the copyright line is modified.
  • The chosen approach works with the repository's branch protection rules.

Open question

Should the workflow commit directly to main, or open a PR for review each year?

Vorherrschende Sprache
Python
Sterne
12
Forks
27
Ø Merge
2 Min.
Gemergte PRs (30 T.)
1

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus StabilityNexus/MiniChain

Alle Issues in StabilityNexus/MiniChain

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.