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

Added: Changelog Feature #61

Draft
wants to merge 51 commits into
base: testnet
Choose a base branch
from
Draft

Added: Changelog Feature #61

wants to merge 51 commits into from

Conversation

Kille135
Copy link
Contributor

No description provided.

@Kille135 Kille135 force-pushed the testnet branch 2 times, most recently from 5d37cfb to 8078129 Compare April 2, 2024 13:26
Copy link
Member

@ales-tsurko ales-tsurko left a comment

Choose a reason for hiding this comment

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

I leaved a comment. And also, maybe I'm wrong, but your pipeline updates the changelog for every pull request, while we need to update it only for testnet release (when we git tag it).

run: |
PR_TITLE=$(jq -r ".pull_request.title" "$GITHUB_EVENT_PATH")
# Check if the pull request title matches the required format
if ! echo "$PR_TITLE" | grep -qE '^(Added|Changed|Deprecated|Removed|Fixed|Security): .+$'; then
Copy link
Member

Choose a reason for hiding this comment

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

The problem here that it violates our style guideline for commmit messages, particularly:

  • the first word is a verb, but not in imperative form
  • it has punctuation symbols we don't need

But it's ok to restrict the words list for merge commits to: "Add", "Change", "Deprecate", "Remove", "Fix". Don't know what to do about "Security". Can we remove it completely?

Also, we need to update our contributing guideline accordingly (the title of a PR can have only these words and the merge request message should be the same as the PR title).

@ales-tsurko ales-tsurko marked this pull request as draft April 8, 2024 13:38
@ales-tsurko
Copy link
Member

Also, please change the file name to CHANGELOG.md (all capital)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants