Skip to content

Clarify docs with required/optional configuration #665

Closed
@bernardcooke53

Description

@bernardcooke53

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    confirmedPrevent from becoming staledocsImprovements or additions to documentationneeds-updateNeeds status update from maintainers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions