Repository navigation
Clarify docs with required/optional configuration #665
Description
Please describe your problem. Include links to any relevant pages or files.
From #659:
What was difficult to me was a) reading the python-semantic-release documentation, it seems inclomplete, particularly regarding the Gitlab configuration and b) identifying deprecated configuration variables. For instance, hvcs, hvcs_domain, and hvcs_api_domain are not mentioned anymore in latest/configuration, but can be found via search (documentation) somewhere nested in the code. They still seem to work and required to get a custom Gitlab CI working. Also, in the migrating_from_v7, it is not mentioned that the env variable GL_TOKEN, which formerly apparently identified Gitlab-CI, does not work anymore and it is required to explicitly add:
[tool.semantic_release.remote]
name = "origin"
type = "gitlab"- Ensure options are documented properly
- Add required/optional indicator to configuration options (put required at top of page, easier to find)
- Review & clarify v7 vs v8 config in migration guide
Activity
github-actions commentedon May 28, 2024
It has been 60 days since the last update on this confirmed issue. @python-semantic-release/team can you provide an update on the status of this issue?
codejedi365 commentedon May 28, 2024
Still in the backlog, however, the configuration docs have improved significantly and now document the missing remote options. Optional vs required is not annotated but I'm not sure this actually exists as we use defaults for everything.
Automatically determining which CI env sounds intriguing but not there yet for that.
github-actions commentedon Jul 29, 2024
It has been 60 days since the last update on this confirmed issue. @python-semantic-release/team can you provide an update on the status of this issue?
codejedi365 commentedon Jul 29, 2024
No change, still in backlog.
6 remaining items
codejedi365 commentedon Dec 2, 2024
Still in backlog
github-actions commentedon Feb 2, 2025
It has been 60 days since the last update on this confirmed issue. @python-semantic-release/team can you provide an update on the status of this issue?
codejedi365 commentedon Feb 2, 2025
Still in backlog
github-actions commentedon Apr 4, 2025
It has been 60 days since the last update on this confirmed issue. @python-semantic-release/team can you provide an update on the status of this issue?
codejedi365 commentedon Apr 4, 2025
Still in backlog
github-actions commentedon Jun 4, 2025
It has been 60 days since the last update on this confirmed issue. @python-semantic-release/team can you provide an update on the status of this issue?
codejedi365 commentedon Jun 14, 2025
Resolved significantly with last release. GitLab docs has its own issue.