Skip to content

Drop .doctrine-website.json #380

@SenseException

Description

@SenseException

With an organisation wide branch naming (1.0.x, 1.1.x, 2.0.x) it should be possible to work with the metadata of the repositories alone to get the information for the website build of the documentation.

  • The default branch is supposed to hold the current alias and is the supported version
  • Every version number above the default branch name is an upcoming version
  • The highest version branch name above the default branch is the latest version
  • Every branch below the default branch (or tags with versions below) are older and unsupported versions

It suggests that only the versions contained by the default branch is a supported version and that every repository marks only one major (or minor) version as maintained. This is currently not the case for every Doctrine project and unlikely a goal. The possibility of a maintained-versions strategy could cover such cases like: "The default branch version and the branch of the following major version are maintained".

These are just first thoughts about a way that we don't need to maintain a website file for every Doctrine repository anymore.

Edit: This is also an opportunity to check why a GitHub token is needed for open repository metadata.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions