Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

V2 format of codecoverage repository #1

Open
stazz opened this issue Jan 2, 2019 · 0 comments
Open

V2 format of codecoverage repository #1

stazz opened this issue Jan 2, 2019 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@stazz
Copy link
Owner

stazz commented Jan 2, 2019

Currently the structure is fragmented so that single project has files in the following directories:

  • docs/<project-name>
  • history/<project-name>
  • badges/<project-name>

This stems from the fact that GitHub pages are nice to configure to read from docs folder of the master branch tip. However, the fragmentation is obviously not nice when working with the repo and generating and uploading code coverages. Furthermore, the partial clone is not as smooth with this structure.

The next version should instead make a symlink docs/<project-name> -> <project-name>/docs, and all of the project's data is stored in one top-level folder named as the project:

  • <project-name>/docs (where the symlink from docs/<project-name> to)
  • <project-name>/history
  • <project-name>/badges

The only question mark with this setup is how well GitHub page handles symlinks, which needs to be tested.

@stazz stazz self-assigned this Jan 2, 2019
@stazz stazz added the enhancement New feature or request label Jan 2, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant