ansys / ansys/actions

Provide option to specify configuration file for `doc-changelog` action

Open
#952 0 comments 1 reaction 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

For repositories containing a `pyproject.toml` and `towncrier.toml`, allow the user to specify using the `towncrier.toml` file. Currently, if both of these files exists it automatically defaults to the `pyproject.toml`

Requested by @ansjhenry

### 💡 Steps for implementing the feature

Add an optional input to the `doc-changelog` action to specify the name of the configuration file. By default, it will be `pyproject.toml`

### 🔗 Useful links and references

_No response_

Contributor guide

Open the contributing guide

Research direction

Start at the doc-changelog action definition and inspect how its configuration file is selected when both pyproject.toml and towncrier.toml exist. Add an optional configuration-file input whose default remains pyproject.toml, and verify that specifying towncrier.toml selects that file.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.