ansys / ansys/actions

Add syntax check on the changelog action

Open
#696 1 comment 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
19
Forks
7
Avg merge
2d 4h
Merged PRs (30d)
50

Description

### 📝 Description of the feature

One of our PyMAPDL PR has the following name:

```md
fix: Improve error handling in *GET method and enhance output logging
```

which triggers a formatting error when releasing.

Ideally, we would like to catch those errors on the PR itself.

Ref: https://github.com/ansys/pymapdl/pull/3758

### 💡 Steps for implementing the feature

_No response_

### 🔗 Useful links and references

_No response_

Contributor guide

Open the contributing guide

Research direction

Start by inspecting the changelog action and the formatting failure described in ansys/pymapdl#3758. Reproduce the invalid PR-title case, then add a check that reports the error during the pull request workflow and verify that valid changelog syntax still passes.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, python
Domain
ci-cd
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
64/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.