Skip to content

Clarify docs with required/optional configuration #665

Closed
Closed
Clarify docs with required/optional configuration#665
Labels
docsImprovements or additions to documentationneeds-updateNeeds status update from maintainers

Description

@bernardcooke53
bernardcooke53
opened on Jul 26, 2023

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

  1. bernardcooke53
    added
    docsImprovements or additions to documentation
    on Jul 26, 2023
  2. bernardcooke53
    self-assigned this
    on Jul 26, 2023
  3. github-actions
    added
    stale
    on Mar 25, 2024
  4. codejedi365
    added
    confirmedPrevent from becoming stale
    and removed
    stale
    on Mar 29, 2024
  5. codejedi365
    unassigned
    bernardcooke53
    on Mar 29, 2024
  6. python-semantic-release
    deleted a comment from github-actions on Mar 29, 2024

  7. github-actions commented on May 28, 2024

    @github-actions
    github-actionsbot
    on May 28, 2024 – with GitHub Actions

    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?

  8. github-actions
    added
    needs-updateNeeds status update from maintainers
    on May 28, 2024

  9. codejedi365 commented on May 28, 2024

    @codejedi365
    codejedi365
    on May 28, 2024
    Contributor

    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.

  10. github-actions
    removed
    needs-updateNeeds status update from maintainers
    on May 29, 2024

  11. github-actions commented on Jul 29, 2024

    @github-actions
    github-actionsbot
    on Jul 29, 2024 – with GitHub Actions

    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?

  12. github-actions
    added
    needs-updateNeeds status update from maintainers
    on Jul 29, 2024

  13. codejedi365 commented on Jul 29, 2024

    @codejedi365
    codejedi365
    on Jul 29, 2024
    Contributor

    No change, still in backlog.

  14. github-actions
    removed
    needs-updateNeeds status update from maintainers
    on Jul 30, 2024

  15. 6 remaining items

  16. codejedi365 commented on Dec 2, 2024

    @codejedi365
    codejedi365
    on Dec 2, 2024
    Contributor

    Still in backlog

  17. github-actions
    removed
    needs-updateNeeds status update from maintainers
    on Dec 3, 2024

  18. github-actions commented on Feb 2, 2025

    @github-actions
    github-actionsbot
    on Feb 2, 2025 – with GitHub Actions

    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?

  19. github-actions
    added
    needs-updateNeeds status update from maintainers
    on Feb 2, 2025

  20. codejedi365 commented on Feb 2, 2025

    @codejedi365
    codejedi365
    on Feb 2, 2025
    Contributor

    Still in backlog

  21. github-actions
    removed
    needs-updateNeeds status update from maintainers
    on Feb 3, 2025

  22. github-actions commented on Apr 4, 2025

    @github-actions
    github-actionsbot
    on Apr 4, 2025 – with GitHub Actions

    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?

  23. github-actions
    added
    needs-updateNeeds status update from maintainers
    on Apr 4, 2025

  24. codejedi365 commented on Apr 4, 2025

    @codejedi365
    codejedi365
    on Apr 4, 2025
    Contributor

    Still in backlog

  25. github-actions
    removed
    needs-updateNeeds status update from maintainers
    on Apr 5, 2025

  26. github-actions commented on Jun 4, 2025

    @github-actions
    github-actionsbot
    on Jun 4, 2025 – with GitHub Actions

    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?

  27. github-actions
    added
    needs-updateNeeds status update from maintainers
    on Jun 4, 2025
  28. codejedi365
    closed this as completedon Jun 14, 2025

  29. codejedi365 commented on Jun 14, 2025

    @codejedi365
    codejedi365
    on Jun 14, 2025
    Contributor

    Resolved significantly with last release. GitLab docs has its own issue.

  30. codejedi365
    removed
    confirmedPrevent from becoming stale
    on Aug 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsImprovements 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