redhat-cop / redhat-cop/openshift_virtualization_migration_ees

fix: CHANGELOG contains stale GitLab commit URLs after migration to GitHub

Open Beginner friendly
#7 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
1
Forks
3
PR merge metrics
No merged PRs in 30d

Description

Problem

After migrating from GitLab to GitHub, CHANGELOG.md still references commit hashes as links pointing to gitlab.consulting.redhat.com. These links are inaccessible from the public GitHub repository and mislead contributors trying to trace changes.

Example from CHANGELOG.md:

([`7db166a`](https://gitlab.consulting.redhat.com/redhat-cop/openshift-virtualization-migration/openshift_virtualization_migration_ees/-/commit/7db166a...))

Proposed Solution

Update historical CHANGELOG.md commit links from gitlab.consulting.redhat.com/... to the equivalent GitHub URLs:
https://github.com/redhat-cop/openshift_virtualization_migration_ees/commit/<hash>

Going forward, ensure pyproject.toml is configured to generate GitHub-native commit links via python-semantic-release.

Files to Change

  • CHANGELOG.md
  • pyproject.toml (verify [tool.semantic_release.remote] section points to GitHub)

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

Start by searching CHANGELOG.md for gitlab.consulting.redhat.com links and inspect the [tool.semantic_release.remote] section in pyproject.toml. Update the historical links to the specified GitHub commit format and verify the semantic-release remote points to GitHub; done means no stale GitLab commit URLs remain.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, python
Domain
documentation, release
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.