Skip to content
This repository was archived by the owner on Mar 13, 2024. It is now read-only.
This repository was archived by the owner on Mar 13, 2024. It is now read-only.

Incorrect Organization replacement in generated README #75

@AlexanderWells-diamond

Description

@AlexanderWells-diamond

The script appears to be too overzealous in where it replaces the Organization in the generated README. In a project that uses this skeleton but is NOT in DiamondLightSource, I ended up with this:

.. note::

    This project contains template code only. For documentation on how to
    adopt this skeleton project see
<<<<<<< HEAD
    https://DiamondLightSource.github.io/python3-pip-skeleton-cli
=======
    https://PandABlocks.github.io/PandABlocks-ioc-cli
>>>>>>> 0e83e5c2b65b4964bc84cf46135c2bfc4768f1a8

The https://PandABlocks.github.io/PandABlocks-ioc-cli address is incorrect - this whole line should be left untouched as that's the real address of the skeleton project.

This issue also affects multiple paths in the created file in docs/developer/explanations/decisions/ e.g.:

  • 2. Adopt PandABlocks-ioc for project structure
  • We should use the following pip-skeleton <https://github.com/PandABlocks/PandABlocks-ioc>_.
  • This module will use a fixed set of tools as developed in PandABlocks-ioc

And, if it matters, when I applied the skeleton I specified both a --org PandABlocks and --package pandablocks_ioc.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions