Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Check the presence of changelog for the latest stable release in History.md #1999

Open
wants to merge 10 commits into
base: dev
Choose a base branch
from

Conversation

ia
Copy link
Collaborator

@ia ia commented Nov 18, 2024

  • Please check if the PR fulfills these requirements
  • The changes have been tested locally
  • There are no breaking changes
  • What kind of change does this PR introduce?
    Detecting the presence of changelog for the latest stable release in History.md.

  • What is the current behavior?
    We should add changelog manually but sometimes we may forget because there is no any test check for this.

  • What is the new behavior (if this is a feature change)?
    Extend test step for docs using GitHub Actions with the following algorithm: check History.md for the latest stable release, check git tag for the latest stable release, and if they mismatch then trigger error.

  • Other information:

Not sure how it will work at the moment of tagging though. I guess we will see. :)

But basically now the push of the new release tag to dev must be with the same commit of changelog to History.md. Otherwise there will be a reminder in the form of red build, but next commit of changes to History.md probably will fix it. That's the point after all.

Another one important notice for contributors, or what's new today I learned about git/hub: sometimes tags must be synced manually because for some reason just merging with upstream is not enough to sync some metadata such as tags, i.e.:

(in your local directory with the forked repo)
$ git fetch --tags upstream
$ git push --tags

Without this, Actions in forked repos may not be fetching the latest actual git tags from upstream even if anything else is properly merged, synced, and up-to-dated. 🤷‍♂️

@ia ia requested review from Ralim and discip November 18, 2024 23:10
@ia ia added Build System make/bash/python, github CI/CD & pals. Documentation Markdown, ReadTheDocs & GH Pages. labels Nov 18, 2024
Copy link
Collaborator

@discip discip left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ia
Although I understand roughly what this does, I not capable to approve your changes as I am not a programmer and therefore lack the necessary expertise. 😅
So you will have to wait for Ralim to approve it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Build System make/bash/python, github CI/CD & pals. Documentation Markdown, ReadTheDocs & GH Pages.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants